用途:fix-docs 用于修复文档缺口。它先调用 /check-docs 审计文档,找出最高优先级的问题,然后只修复这一个问题,验证并报告结果。每次调用只处理一个问题,需再次运行以处理下一个。
主要能力与优先级:P0 为缺失 README.md、缺失 .env.example;P1 为 README 缺少章节、未记录的环境变量、架构文档;P2 为过时文档、CONTRIBUTING.md、ADR;P3 为润色与附加内容。
使用方式:先运行 /check-docs 获取按优先级排序的发现,再按上述顺序修复。缺失 README.md 时生成包含项目名称与标语、功能说明、Quick Start(最多 3 条命令)、配置(环境变量)、开发命令、许可证的结构。缺失 .env.example 时可用资料中给出的 grep 命令扫描环境变量并生成文件。README 缺章节则补充;未记录的环境变量加入 .env.example 并加注释;缺架构文档可调用 /cartographer 生成 CODEBASE_MAP.md;过时文档则审查更新。修复后验证文件存在与内容,例如检查 README.md、.env.example 是否存在,以及是否含安装与快速开始章节,然后报告已修复项与下一个最高优先级项。
分支与限制:修改前可执行 git checkout -b docs/fix-$(date +%Y%m%d)。该技能一次只修一个问题,便于审查、回滚与保持提交历史清晰。相关技能包括 /check-docs(仅审计)、/log-doc-issues(只创建问题)、/documentation(完整文档流程)、/cartographer(生成架构文档)。具体平台与收费信息暂未提供。