documentation-writing 是面向技术文档与 API 文档的写作规范集合,用于指导开发者编写结构清晰、易于维护的文档。
核心原则:面向特定读者;以任务为导向,帮助用户完成目标;内容可快速扫读,使用标题、列表和代码块;与代码保持同步;覆盖常见用例与边界情况。
README 结构建议包含:项目名称与一到两句简述、功能列表、安装(如 npm install package-name)、快速开始(最小可用示例)、基础用法、高级用法、API 参考链接、贡献指南和许可证。
代码注释采用 JSDoc/TSDoc,按函数、类、接口分别说明。函数注释可含参数(@param)、返回值(@returns)、示例(@example)和异常(@throws);类注释可用 @remarks 补充说明;接口字段可标注 @default 与 @example。
API 文档方面,可编写 OpenAPI 3.0.3 规范,定义 info、paths、parameters、responses 和 components/schemas,并用 $ref 复用模型。端点文档应给出请求方法路径(如 POST /api/v1/users)、请求头表格(Authorization、Content-Type 等)、请求体 JSON 与字段表格(字段、类型、是否必填、说明),以及成功(201 Created)和错误(400 Bad Request)响应示例,错误体含 code、message、details。
代码示例应贴近真实场景,包含导入、初始化与错误处理,避免过于抽象;示例保持最小化,只展示概念,并确保可运行。变更日志按 Added、Changed、Fixed、Deprecated、Security 分组,记录版本号、日期与关联 issue 编号。
最佳实践还包括:用标题、要点和表格便于扫读;用示例代替空泛描述;随代码更新文档;测试示例是否有效;适度链接相关概念;统一术语;提供常见错误与排查方法。
限制方面:资料未提供该技能的具体安装方式、运行平台、收费信息或与特定工具链的集成步骤,均暂未提供。