documentation - 技术文档最佳实践
技术文档最佳实践，涵盖 README、API 文档、注释、架构图和用户指南
标签
更新于: 2026-05-28能力
典型输入
典型输出
该技能可以做什么
- 编写 README
- 编写 API 文档
- 添加代码注释
- 创建架构图
- 编写教程
- 编写指南
- 创建变更日志
- 记录接口
- 编写文档字符串
输入
- 项目信息
- API 规范
- 代码文件
- 架构详情
- 代码示例
- 版本历史
- 认证详情
输出
- README 文件
- API 参考文档
- 内联注释
- 架构图
- 用户指南
- 教程
- 变更日志文档
要求
- Markdown 知识
- 技术写作能力