说明高质量技术文档的关键原则。
明确受众:先想清楚给谁看(新人/同事/跨团队),决定深度与术语。
结构清晰:用标题层级、目录、TL;DR 让信息可扫读;结论先行。
示例充分:关键 API/流程配可运行的代码示例与图,胜过千言。
可维护:单一信息源、与代码/版本联动、标注最后更新与责任人,避免文档腐烂。好文档降低沟通成本、是团队资产而非负担。
题目与答案就在本页;收藏、批注和错题重练在应用内