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 從公開儲存庫中收錄這些內容。

檢舉或申請下架