W Docs

blockmatic/basilic-skills/skills/workflow/w-docs

作者 blockmatic7e05e2abd052dc6b526e8a28e36d102d42bfd635无许可证1 个星标收录于 2026年10月9日更新于 2026年10月9日仓库6天前更新

Document the current code or feature in the owning docs layer.

AI 生成的概览

指导智能体在代码或功能变更时更新正确的文档层。

功能
该技能指导智能体在代码或功能变更时确定应记录到哪一层文档,可在技术文档、智能体规则和最近的 README 之间选择。它给出五步流程:找到匹配的文档章节;当权威说明变化时修补 MDX;仅针对运行、安装或脚本变更修补 README;仅在约束变化时修补规则;对机械性的文件或文档移动,提出最小的 from/to 清单。它还规定除非被要求否则不提交,也不把 MDX 内容复制到规则或 README 中。
适用场景
当代码或功能变更需要反映到仓库文档中时使用。它适用于将技术文档、智能体规则和 README 作为独立层并明确归属的仓库。它不用于新建文档站点地图,也不用于在未被要求时提交变更。
运行要求
无需脚本或特殊工具,仅为说明性指令。它假定使用方仓库具有文档层、AGENTS.md 路径引用和 README 文件,并且智能体能够编辑 MDX 与 Markdown 文件。

Document the current code or feature. Follow the consuming repo's docs and README rules. Do not commit unless asked. Durable information architecture belongs in existing MDX; do not invent a second sitemap.

Write to the layer that owns the change:

LayerRoleUpdate when
Technical docs (path in AGENTS.md)Architecture, ADRs, how-toBehavior, architecture, commands, conventions, or workflow changed
Agent rulesShort constraintsA convention the agent must not violate changed
Nearest READMEHow to run this app/package; links onlyScripts, setup, or package purpose changed

Inline comments only when the code is otherwise misleading. Do not copy MDX into rules or READMEs. Do not @-attach MDX.

  1. Identify the matching docs section, then an existing topic page (create a page only if none fits).
  2. Write or patch MDX if the canonical explanation changed.
  3. Patch README only for run/setup/scripts; link the MDX.
  4. Patch the glob-matched rule only if a constraint changed.
  5. For mechanical file or doc moves: propose the smallest from/to list grouped by related files; drop folder-name prefixes inside groups. Save only if the user gave a path. Do not move files unless they also asked to implement.

来源与署名

来源:blockmatic/basilic-skills位于skills/workflow/w-docs提交7e05e2a

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架