用途
Code Documentation 是一个专注于编写有效代码文档的技能，适用于为代码库、API 编写文档，或撰写面向开发者的技术指南。它覆盖 README 文件、API 文档、内联注释以及架构与组件文档等常见文档类型。
主要能力
README 结构
提供标准 README 模板，包含以下章节：项目名称与简要描述、快速开始（如 npm install、npm run dev）、详细安装说明、用法示例（TypeScript 导入与调用示例）、API 参考（函数签名、参数、返回值与示例）、配置项表格（选项、类型、默认值、说明）、贡献指南以及许可证（如 MIT）。
API 文档
- JSDoc/TSDoc 风格：给出函数与接口的注释示例，包括
@param、@returns、@throws、@example等标签，以及接口属性的说明与@default默认值标注。 - OpenAPI/Swagger：给出 OpenAPI 3.0.0 规范示例，包含
info、paths（如/users的 POST 请求）、requestBody、responses（201、400）以及components/schemas（UserInput、User）的定义。
内联注释
说明何时应该注释、何时不应注释：
- 应当注释：解释“为什么”而非“是什么”（如使用二分查找的原因）；说明复杂业务逻辑（如会员折扣规则）；记录临时方案（如 Safari 兼容性回退，标注 HACK/TODO 及跟踪链接）。
- 不应注释：陈述显而易见的内容（如
counter++）；解释清晰的代码（如判断管理员角色）；过时的注释（比没有注释更糟）。
架构文档
- ADR（架构决策记录）：示例包含状态、背景（考虑过的选项）、决策、理由与后果等部分。
- 组件文档：示例包含概述、流程（如认证模块的 JWT 流程）、依赖（如 jsonwebtoken、bcrypt、redis）与配置项（如 JWT_SECRET、ACCESS_TOKEN_EXPIRY、REFRESH_TOKEN_EXPIRY）。
文档原则
- 面向读者写作（新开发者 vs API 使用者）
- 让文档贴近代码（同一仓库、靠近相关代码）
- 随代码更新（过时文档比没有更糟）
- 多用示例而非单纯解释
- 渐进披露（先快速开始，后细节）
使用方式
资料中未提供该技能的具体安装命令或调用步骤，暂未提供。
适用场景
适用于需要为代码库、API 或开发者文档进行文档化的场景，包括编写 README、API 参考、内联注释、架构决策记录与组件说明。
限制
资料中未说明该技能的收费、价格、支持平台或具体效果，暂未提供。