用途
w-docs 用于为当前代码或功能编写文档。其核心原则是:把文档写到拥有该变更的文档层,而不是随意新增文件或另建一套信息架构。
主要能力
- 按变更类型定位应更新的文档层:
- 技术文档(路径见 AGENTS.md):负责架构、ADR、操作指南;当行为、架构、命令、约定或工作流发生变化时更新。
- 智能体规则:负责简短约束;当智能体不可违反的约定发生变化时更新。
- 最近的 README:负责如何运行此应用/包,仅放链接;当脚本、安装或包用途变化时更新。
- 内联注释:仅在代码本身容易误导时使用。
- 识别匹配的文档章节,再定位到已有主题页面;只有在没有合适页面时才创建新页面。
- 若权威解释发生变化,则编写或修补 MDX。
- 仅针对运行、安装、脚本修补 README,并链接到 MDX。
- 仅当约束变化时,修补 glob 匹配的规则。
- 对于机械性的文件或文档移动:按相关文件分组,提出最小的 from/to 列表;组内去掉文件夹名前缀。仅在用户给出路径时保存。除非用户同时要求实施,否则不移动文件。
使用方式
遵循所在仓库的文档与 README 规则。未经要求不要提交。持久的信息架构应放在现有 MDX 中,不要发明第二套站点地图。不要把 MDX 复制到规则或 README 中,也不要 @ 附加 MDX。
适用场景
适用于需要为当前代码或功能补充、更新文档的仓库,尤其是已有明确文档分层(技术文档、智能体规则、README、内联注释)和 MDX 信息架构的项目。
限制
- 未经要求不提交。
- 不另建第二套站点地图。
- 不把 MDX 复制到规则或 README。
- 不 @ 附加 MDX。
- 仅在用户给出路径时保存文件移动方案;除非用户要求实施,否则不移动文件。
- 关于收费、价格、平台支持等具体信息,资料中暂未提供。