用途:帮助编写清晰的技术文档,适用于创建 README、API 文档或用户指南。
主要能力:覆盖多种文档类型。README 应说明项目功能、安装/设置方法、基本用法示例及更多信息位置;API 文档应包含端点与方法、请求/响应格式、认证、错误码和示例;架构文档应包含系统概览、组件图、数据流和关键决策(ADR);用户指南应包含分步说明、截图/示例、常见工作流和故障排查。
写作原则:了解受众(开发者、用户还是管理员,他们已知什么、需要完成什么);简洁(短句、主动语态、删除冗余词);展示而非陈述;为便于扫读而结构化(标题、项目符号、代码块、表格)。
使用方式:资料提供了 README 模板与 API 文档示例。README 模板包含项目名称、简要描述、安装(如 npm install project-name)、快速开始、文档链接、贡献指南和许可证。API 文档示例展示 POST /api/users 的请求体、响应体及错误码表(400 无效请求体、409 邮箱已存在)。
适用场景:编写 README、API 文档、架构文档和用户指南。
限制:资料未提供该技能的具体安装命令、平台支持、收费信息或实际运行步骤,这些内容暂未提供。