夜雨聆风学习资料网

ARTICLE · 1115137

Vibecoding文档怎么写!百万行开发项目文档已开源!

Vibecoding文档怎么写!百万行开发项目文档已开源!
百万行开发项目文档已开源!
https://github.com/IM-DaXiong/bgxiong-ai-story-docs

无法访问的,或者想用现成蒸馏好的SKILL在这里

顶级Astra模型蒸馏了24小时

Token直接炸了 | 这个月已无预算

https://www.bgxiong.com/goods/9p65SRB2Sl

BGX 开发治理 · bgx-dev

让项目的决定、规范和进度,成为可以长期接手的资产。

AI 可以快速生成代码。但项目真正变难,往往发生在代码写出来之后:为什么这样设计?哪些需求已经确认?哪个接口才是当前约定?上次修复做到了哪一步?换一个智能体,它能否继续而不推翻已有成果?

这些问题需要一套持续维护的项目文档来回答。

bgx-dev 是面向编码智能体的项目开发治理技能,以可追溯的文档系统贯穿需求、规划、开发、排错和交付。它要求把讨论落成记录,把选择落成决定,把开发落成任务,把完成结论落到验证证据上。

你在聊天里看概要,项目目录中保留详细依据。下一次开发,从文档接着做。

为什么文档对开发如此重要

代码能说明当前如何运行,需求和设计记录说明为什么这样做。缺少这些依据,后续开发容易把已经讨论过的约束当成新问题,把有意保留的行为当成缺陷,或在不同模块重复实现相同规则。

聊天可以推进讨论,项目文档保存可继续执行的结论。决定散落在不同窗口里,接手的人或智能体就要重新拼接背景。目标、边界、未决问题、验证结果和下一步有稳定记录,才有共同的工作起点。

文档也是开发中的检查依据。需求明确成功标准,合同约束跨端字段与错误语义,计划暴露任务依赖,修复记录保存根因与回归结果。这些内容帮助开发者判断一次改动是否符合目标、是否影响其他模块、是否真的完成。

当项目扩大,文档治理会直接影响返工、协作、排错和交付。bgx-dev 把维护这些依据纳入每一次开发任务。

bgx-dev 如何治理文档

1. 自动落盘:分析结果成为项目资料

首次体检自动生成 Markdown 报告、候选整改计划和资料索引;产品规划分阶段保存需求、规范、计划和交付方案。

关键讨论、草稿与未决问题及时保存,不等整个流程结束才归档。写入后要求读回核对内容与链接,再在聊天中提供概要和真实文档入口。

用户价值:关闭窗口后,仍能找到分析依据、待决问题和下一步。

2. 分类与导航:项目越大,资料仍有入口

需求、指南、合同、计划、故障记录和验证报告各有职责。索引保存主题、状态与链接,详细内容留在对应文档。

优先沿用项目现有约定;缺少规范时再提供时间命名、目录分类和稳定入口。避免把所有资料堆进一个越来越长的智能体指令文件,也不为统一格式随意搬动旧资料。

用户价值:接手时可以从索引按需阅读,不必把整个文档目录重新通读。

3. 单一权威源:减少多份文档互相矛盾

同一需求、合同或任务保留一个权威正文,其他位置引用它。实施阶段引用原任务,故障续修更新原 FIX,新会话继续原 PLAN。

有效规范继续保留;被替代内容标明原因、时间和替代链接。历史有据可查,当前约定也能明确定位。

用户价值:减少“这个窗口说一种、另一个文件写另一种”的协作混乱。

4. 状态与证据分开记录:完成结论有依据

用户确认与暂定假设分开,已实现与已验证分开,计划完成与产品交付分开。

任务记录检查命令、运行环境、结果及未验证项。找不到证据标待核实,环境受阻标明原因;不能因为写好了文档或通过静态检查就宣称产品已经可用。

用户价值:更容易看清项目真正的进度,以及交付前还缺什么。

5. 随改动同步:文档维护成为任务的一部分

每次使用 bgx-dev 规划、开发、修 BUG 或交接,都要求核对文档影响。需求变化时更新需求与计划;合同或行为变化时更新规范;修复后更新故障记录、验证结果与索引。

仅修改实际受影响的内容,保留人工记录和未完成事项。小任务可以在原章节中留档,复杂工作再拆独立文档,避免文件越写越多却无人维护。

用户价值:帮助缩小“代码已经改了,文档还停在旧版本”的落差。

6. 贯穿全流程:留下可追溯的开发链路

需求或 BUG → 证据 → 设计与计划 → 实施任务 → 验证结果 → 当前状态与下一步。

稳定 ID、文档链接和执行台账串起这些环节。遇到阻塞先保存现场和决定需求,新会话从索引、计划与相关记录恢复工作。

用户价值:其他开发者或智能体可以沿记录接手,知道哪些决定已确认、哪些任务待做、哪些结果尚未验证。

在这些场景中使用

从想法到产品:分轮澄清模糊需求,选择简版、标准或深入,生成指定目录中的项目规范、开发计划、实施阶段与交付方案。

已有项目体检:查规则、代码、日志和合同,保存有证据的缺口与可执行选项;你选定范围后再整改。

BUG 修复:先查相关日志,再沿证据查代码和合同,保存修复计划,按授权修复、验证并同步文档系统。

长期迭代与交接:从原计划接续任务,维护决定、证据、状态与下一步,让项目资料跟随每次工作积累。

一句话开始

用 bgx-dev 帮我建立并持续维护这个项目的文档系统。先澄清需求,文档保存到指定目录;分析、计划、修复与验证及时归档,聊天给概要和文档链接,业务实施按我的授权执行。

也可以只调用具体工作:

用 bgx-dev 先体检项目,保存报告和整改计划,等我选定后修改。

用 bgx-dev 修复这个 BUG,先查日志、保存计划,完成后更新修复记录、验证结果和相关文档。

用 bgx-dev 读取资料索引,继续上次计划的下一项。

适合谁与使用条件

适合使用 AI 开发产品的个人开发者、小团队、接手已有项目的开发者,以及跨窗口、跨智能体协作的团队。

商品包含标准技能目录、中文使用说明和独立完整版文本。自动保存与实际验证需要智能体具备文件访问和执行权限;纯聊天环境可起草资料,但不能宣称已落盘或运行。技能在被调用时维护项目,不是常驻后台监控服务,跨客户端调用与链接展示按客户端实际能力使用。

百万行开发项目文档已开源!
https://github.com/IM-DaXiong/bgxiong-ai-story-docs

无法访问的,或者想用现成蒸馏好的SKILL在这里

顶级Astra模型蒸馏了24小时

Token直接炸了 | 这个月已无预算

https://www.bgxiong.com/goods/9p65SRB2Sl

相关学习资料