技术文档

概述

技术文档是描述软件系统、API、功能或架构的文档，通常包括API文档、用户指南、架构文档、变更日志条目和代码注释改进等内容。

关键内容

1. 文档类型：
2. API文档：包含端点描述、参数、返回值、错误信息和使用示例
3. 用户指南和教程：帮助用户理解和使用系统的文档
4. 架构文档：描述系统设计和组件间关系的文档
5. 变更日志条目：记录版本变化的文档

6. 代码注释改进：提升代码可读性的注释

7. 文档标准：

8. 清晰：使用简单、明确的语言
9. 示例：包含实用的代码示例
10. 完整：覆盖所有参数和返回值
11. 结构：使用一致的格式

12. 准确：根据实际代码验证

13. API文档结构：

14. 描述：端点功能的简要说明
15. 参数：包含名称、类型、是否必需和详细描述的表格
16. 返回值：响应格式和类型的说明
17. 错误：可能抛出的异常和HTTP状态码
18. 示例：包含curl、JavaScript、Python等多种语言的代码示例

来源

• raw/assets/claude-howto/04-subagents/documentation-writer.md — 源文件

相关

• Documentation Writer Agent — 相关概念
• API文档生成器 — 相关工具
• 用户指南 — 相关文档类型
• 架构文档 — 相关文档类型