用途:管理存放在 docs/ git 子模块中的文档,保证结构规范、同步远端并纳入版本控制。适用于用户明确提到“add docs”“specs”等文档相关操作时。
主要能力:确保子模块已初始化;维持结构化文档目录(solutions/specs/feature);修改前先同步远端;在子模块和父仓库两处分别提交。
使用方式:
- 确认子模块已初始化:若 docs/.git 不存在,优先执行 npm run setup(如 package.json 中存在 setup),否则执行 git submodule update --init --recursive。
- 确定目录结构:进入 docs/<repo-name>/,按内容类型选择 solutions/<issue>/(bug 修复、问题记录)、specs/<feature>/(技术方案、实施计划、进度)、feature/<feature-name>/(PRD、需求、用户故事);specs/ 常用 implementation-plan.md 和 progress.md。内容不符时可新建 research/、rfcs/、architecture/ 等描述性目录。
- 创建或修改文档:mkdir -p specs/<feature-name>,再用写入或编辑工具生成文件。
- 同步与提交:在 docs 子模块内执行 git fetch origin、git pull origin master、git add .、git commit -m "doc: added spec for <feature-name>"、git push origin master;回到父仓库执行 git add docs、git commit -m "doc: update docs submodule for <feature-name>"。提交信息格式如 doc: added solution for <issue-name>、doc: added PRD for <feature-name>。
限制:若子模块 pull 因冲突失败,需提示用户并询问是否 stash 或手动解决,未经明确许可不得强制推送或 reset;目录结构缺失时创建 docs/<repo-name>/ 及对应子目录;无法判断分类时询问用户,必要时建议新建分类。详细结构见 references/structure-guide.md。资料未提供安装命令之外的额外配置、收费与平台信息。