用途
该技能旨在帮助开发者编写“开发者真正愿意阅读和维护”的文档，适用于代码、API 和系统文档的创建。它强调文档应具备清晰、完整、及时、简洁、易扫读和实用等特质，并围绕这些理念提供具体做法。
主要能力
技能覆盖以下文档类型及其写作要点：
- README 文件：作为项目门面，需说明项目做什么、如何快速开始、在哪里找到更多信息以及如何贡献。
- 代码注释：强调解释“为什么”而非“是什么”，用于说明复杂算法或特殊处理原因，避免陈述显而易见的内容。
- API 文档：对公开 API 进行详尽说明，包括参数、返回值、可能抛出的错误以及使用示例。
- 架构文档：解释系统组件、数据流和关键设计决策及其原因。
- 安装文档：帮助新开发者快速搭建环境，包含前置条件、安装步骤和故障排查。
- ADR（架构决策记录）：记录重要决策的背景、决定、后果和备选方案。
技能还总结了三种文档模式：教程式指南（完整示例逐步引导）、参考文档（API 快速查阅）和故障排查指南（帮助用户解决常见问题）。
使用方式
技能以最佳实践和示例的形式呈现，可直接参考其中的结构、格式和写作原则来编写文档。具体包括：
- 保持文档贴近代码，例如在模块目录中放置 README 和示例文件。
- 使用 Markdown 格式化，包括标题、加粗、代码块、引用和列表。
- 始终提供可运行的代码示例。
- 链接相关文档，保持内容更新（可添加“最后更新”说明）。
- 使用 JSDoc 为 TypeScript 接口和函数添加注释，使用 README 徽章展示构建、覆盖率、许可证状态，使用 Mermaid 绘制流程图。
- 遵循新功能文档检查清单，涵盖 README 更新、JSDoc 注释、使用示例、配置说明、错误信息解释、故障排查、相关链接、架构图更新、清晰度审查和代码示例测试。
- 避免常见错误，如文档过时、使用未解释的术语、示例缺少错误处理、记录内部实现细节、冗长、假设读者已有背景知识等。
- 践行“文档即代码”，将文档示例与测试结合，确保示例始终有效。
适用场景
适用于需要为代码库、API 或系统编写和维护文档的开发场景，尤其适合希望提升文档质量、可读性和可维护性的团队或个人开发者。
限制
资料中未提供该技能的具体安装命令、运行环境要求、收费模式或平台支持信息，这些内容暂未提供。