documentation

此技能作为专属技术撰写人员，使 Claude 能够生成、组织并维护高质量的工程文档。它专为需要将复杂系统行为或操作需求转换为可读、可执行格式的软件开发人员、系统架构师与技术主管而设计。通过遵循既定的文档标准，此技能确保技术知识能在团队中有效共享，进而缩短入职时间并降低维护成本。

• 自动生成包含项目目的、配置步骤与贡献指南的 README 文件。

• 构建包含端点参照、验证细节、速率限制以及请求/响应示例的完整 API 文档。

• 制定操作手册，概述事件响应中的先决条件、逐步程序、回滚步骤与升级路径。

• 建立架构决策记录 (ADR)，记录高阶设计、权衡分析、数据流与整合点。

• 制作包含环境设置、系统对应图与常用工作流程导览的入职指南，协助新团队成员快速上手。

• 强制执行文档编写原则，例如针对读者进行调整、优先呈现关键信息、使用清晰示例，并维持单一真实来源。

• 提供上下文或代码片段作为输入以生成精准且相关的草稿；此技能擅长将原始开发数据转化为精炼的文字。

• 始终秉持“演示胜过说明”的原则，适当时加入终端指令、SDK 用法与系统图表。

• 定期根据实际的代码库或基础设施审核现有文档，确保其时效性。

• 采用交互参照与链接而非复制内容，以降低维护心力并维持高准确度。

• 适用于多种格式，包括 Markdown、OpenAPI 规格书或内部维基页面。

• 限制：当提供具体的技术上下文或原始文件时，此技能表现最佳；请确保在共享用于文档处理的内容之前，已移除 API 密钥或内部凭证等敏感资料。