用途:在开发仓库中创建、实质性更新、重构或审查 Markdown/MDX 工程文档,包括 README 等。目标是让目标读者能完成任务、查阅事实或理解决策,技术论断须以仓库为依据,保留原意与本地语气,改动不超出请求的文档范围。
模式:创建或更新(检查实现并编辑指定文档);结构或风格(改进现有页面但不虚构新事实);审查(返回有证据支撑的发现,不改文件)。出现 review、assess、check 等词即选审查模式,除非用户同时要求修复或重写。文档请求不授权改动实现。
快速开始:阅读仓库说明、目标文档及邻近页面以确定语言、术语、渲染器和导航约定;说明目标读者与页面的首要读者任务;确定模式与证据需求;只起草或修订服务于该任务的章节,TEMPLATES.md 仅作菜单而非强制页面形状;重读完整改动页、检查 diff,并核对链接、锚点、路径、命令、名称、默认值、示例与渲染器语法。
文档任务:入门(前置条件、受支持安装路径、命令、成功信号)、执行任务(前置条件、有序操作、可观察验证、有证据的恢复)、查阅 API 或选项(名称、类型、必需/默认行为、约束、示例、错误)、理解架构(上下文、当前设计、边界或数据流、理由、权衡)、记录决策(状态、上下文、决策、备选方案、后果)、贡献改动(受支持安装、检查、约定、提交流程)。不得为缩短页面而省略必要事实;若关键证据缺失或矛盾,应指出缺口及其后果。
五个缩放层级:句子、项目符号、章节、页面、跨页面,按能解决读者问题的最小层级处理。这些是决策规则而非硬性 lint。
内容与编辑契约:保留需求、条件、例外、不确定性、引用、安全警告与有意术语;当前命令或决策先于历史;散文用于推理、列表用于并列项、表格用于重复字段、代码用于可复制输入、图表仅用于散文难以说明的关系;易变事实尽量单一维护者;使用明显虚构的占位符,不暴露凭据,不暗示未运行的命令已测试;仅在代码、测试、问题或用户证据支持时添加故障排查;匹配目标渲染器后再加提示块、标签页、折叠块或 MDX 组件;重命名标题或锚点前搜索入站引用。
范围与权限:审查模式报告位置、影响、证据与具体修复;编辑模式只改请求页面及紧密耦合的导航或锚点;不拆分文件、不创建全站新约定、不重写邻近页面,除非请求包含该范围;代码与规范冲突时应呈现冲突。
验证:交付前应用 CHECKLIST.md,至少核对改动路径、链接、锚点、命令、API 名称、默认值、单位、环境变量与示例的来源;运行安全且相称的命令及仓库的 Markdown 格式化器、链接检查器或文档构建;删除或重命名章节前搜索入站引用;检查 diff 是否有无关措辞改动,并以目标读者身份重读页面;区分已运行检查与仅检查或不可用检查。格式化通过不证明事实准确,目视检查不证明链接或命令可用。
输出:先给出创建的文档、修订页面或最高影响发现;编辑时报告改动文件、重要结构决策、非显然事实的仓库证据、已运行检查及任何限制信心的未解决冲突。
参考文件:TEMPLATES.md(需要文档形状时)、PATTERNS.md(技术内容或示例不清时)、CHECKLIST.md(交付前)、style-zoom-rules.md(选择结构修复时)、style-anti-patterns.md(诊断密集或重复散文时)。
注意事项:风格判断无法确定技术论断真假;删除 optional、may、when、单位或版本限制可能造成虚假保证;从其他页面复制的命令未经独立验证;把细节移到链接后可能破坏独立运行手册、可搜索性与离线使用;行数预算仅作诊断,生成的参考与代码密集页面属合理例外;不要强制所有文档套用 README 模板或把所有论点变成项目符号。