用途
Code Documenter 是一个文档专家技能，专注于内联文档、API 规范、文档站点和开发者指南。它适用于任何涉及代码文档、API 规范或面向开发者指南的任务。
主要能力
该技能能够生成、格式化和验证技术文档，涵盖以下方面：
- 内联文档：支持 Google 风格、NumPy 风格、Sphinx 风格的 Python docstring，以及 TypeScript 的 JSDoc 注解。
- API 规范：支持 OpenAPI 3.0/3.1、AsyncAPI、gRPC/protobuf，以及 FastAPI、Django、NestJS、Express、GraphQL 等框架的 API 文档。
- 文档站点：支持 Docusaurus、MkDocs、VitePress 等静态生成器，以及 Swagger UI、Redoc、Stoplight 等交互式 API 文档工具。
- 用户指南与教程：包括入门指南、教程、故障排除和常见问题解答。
- 覆盖率报告：生成文档覆盖率摘要。
使用方式
该技能遵循一套核心工作流：
- 发现：询问格式偏好和排除项。
- 检测：识别语言和框架。
- 分析：查找未文档化的代码。
- 文档化：应用一致的格式。
- 验证：测试所有代码示例能否编译或运行。
- 报告：生成覆盖率摘要。
验证环节针对不同语言提供具体命令：
- Python：使用
python -m doctest file.py检查 doctest 块；使用pytest --doctest-modules进行模块级检查。 - TypeScript/JavaScript：使用
tsc --noEmit确认带类型的示例能够编译。 - OpenAPI：使用
npx @redocly/cli lint openapi.yaml验证规范。
如果验证失败，需要修复示例并重新验证，然后再进入报告步骤。
该技能还提供了按上下文加载的参考指南，涵盖 Python docstring、TypeScript JSDoc、FastAPI/Django API、NestJS/Express API、覆盖率报告、文档系统、交互式 API 文档、用户指南与教程等主题。
适用场景
适用于需要为代码库补充内联文档、生成 API 规范、搭建文档站点或编写开发者指南的场景。具体包括：为公共函数和类编写文档、记录参数类型与描述、记录异常与错误、生成 OpenAPI 规范、配置文档门户、编写入门教程和故障排除指南等。
限制
该技能明确要求：必须在开始前询问格式偏好；必须检测框架以选择正确的 API 文档策略；必须为所有公共函数和类编写文档；必须包含参数类型和描述；必须记录异常与错误；必须测试文档中的代码示例；必须生成覆盖率报告。
同时明确禁止：未经询问假定 docstring 格式；对框架应用错误的 API 文档策略；编写不准确或未经验证的文档；跳过错误文档；冗长记录显而易见的 getter/setter；创建难以维护的文档。
关于该技能的收费、价格、平台支持范围等具体信息，资料中暂未提供。