结构化编写、重构、润色和验收 Markdown 文档。只要用户提到“帮我创建一个需求/问题排查/方案/文档”、写 `README.md` / `PLAN.md` / `troubleshooting` / `snippet`、润色或改写 Markdown 文档、或把零散草稿整理成结构化文档,就应使用这个 skill。知识对象场景先经 `knowledge_mgr` 明确对象职责,再用本 skill 完成结构设计、表达打磨和交付前润色。
knowledge_mgr 承接。../knowledge_mgr/SKILL.md。../knowledge_mgr/references/operation-rules.md,确认对象职责和写回边界。先识别交付物类型,再读取对应 reference,不要一次性读取全部 reference。
【CRITICAL(必须执行,不可协商)】无论交付物类型是什么,都必须先读 common-writing.md。
| 文档类型 | 必读 reference | 按需补读 | 说明 |
|---|---|---|---|
| 通用 Markdown | common-writing.md | 无 | 所有 Markdown 文档的基础规则入口。 |
README.md / 需求文档 | common-writing.md、issue-readme-writing.md | ../knowledge_mgr/references/operation-rules.md | 知识对象场景先确认对象职责,再写需求主干。 |
PLAN.md / 实施方案 |
common-writing.md、plan-writing.md |
exemplars.md、../knowledge_mgr/references/operation-rules.md |
需要校准结构密度时再读 exemplars.md。 |
troubleshooting | common-writing.md、troubleshooting-writing.md | ../knowledge_mgr/references/operation-rules.md | 知识对象场景先确认写回边界。 |
snippet | common-writing.md、snippet-writing.md | ../knowledge_mgr/references/operation-rules.md | 知识对象场景先确认对象职责和归档边界。 |
common-writing.md 与对象特化 reference。knowledge_mgr 的对象规则。完成初稿后,必须执行一次固定润色闭环:
PLAN.md 场景额外回读 exemplars.md 中的评测基线,校准结构密度与表格化承载方式。PLAN.md,也不要把调研细节写进 README.md。pre-commit run --files <doc-path-1> <doc-path-2> ...
交付时给出简短说明:
pre-commit 是否通过。