doc-writing-best-practices

Installation
SKILL.md

Doc Writing Best Practices

中文技术文档的规范集,9 条规则分 3 类。

如何使用本 skill

规则总量小,可以先读索引再按需取;若正在集中整理一批文档,直接通读 AGENTS.md 也不贵。

你在做什么 先读
写任何中文文档 cjk-*(3 条,成本最低收益最直接)
写 README / 设计文档 content-*、struct-heading-no-skip;链接多时 struct-reference-links
写运维手册 / 操作步骤 content-example-copy-ready、struct-code-fence-language
整理已有文档 全部

这类规范的共性

文档的失效方式和代码不同:没有编译器会告诉你写错了。排版不一致、示例抄不动、缺少"为什么"——这些都不会报错,只会让读者慢慢地不再信任这份文档。

Installs
17
Repository
jinsyin/skills
GitHub Stars
1
First Seen
Aug 5, 2026