用途:document 是一个文档生成技能,针对特定组件、函数、API 和功能生成聚焦的文档。该技能不依赖特定运行时,可在 Claude Code、OpenCode 和 Codex 中使用。
使用方式:命令行形式为 /document [要文档化的对象] [格式:inline/api/guide/external]。参数可以是文件路径、函数名、功能区域或对要文档化内容的描述;可选的格式提示用于控制输出风格,省略时根据上下文推断最佳格式。
工作流程:分析目标组件的结构、接口和功能;识别文档需求和目标读者语境;生成相应的文档内容;应用一致的结构和组织模式;确保与现有项目文档生态兼容。关键行为包括:分析代码结构,提取 API 并识别用法模式;生成多种格式的文档(内联、外部、API 参考、指南);保持格式一致并集成交叉引用;匹配项目现有约定。
可用工具:Read 用于组件分析和审阅现有文档;Grep 用于引用提取和模式识别;Write 用于按正确格式创建文档文件;Glob 用于多文件文档项目与组织;Bash 用于分析数据库结构,以生成数据模型文档。
文档格式:内联文档直接向源文件添加 JSDoc、docstrings、typespecs 或内联注释,读取目标文件后识别缺少文档的函数、模块、类型和接口,分析参数类型、返回值、副作用和用法模式,再按语言约定添加注释(JavaScript/TypeScript 用 JSDoc 的 @param、@returns、@example;Elixir 用 @doc、@moduledoc、@spec;Python 用带参数和返回值描述的 docstring),并且只增补、不删除已有文档。API 文档为 API、端点或公共接口生成参考材料,识别公共端点、函数或接口,提取请求/响应模式、参数和返回类型,生成包含签名、参数说明与约束、响应格式与示例、错误情况与状态码、真实数据用法示例的结构化参考,输出到指定路径或 docs/api/。用户指南面向最终用户或开发者创建任务导向文档,分析功能的用户可见行为和常见工作流,按概述与目的、前置条件、分步使用说明、配置选项、常见模式与示例、故障排查的结构组织,输出到指定路径或 docs/guides/。外部文档为组件或库生成独立文档文件,分析公共 API、props/参数和行为,包含组件概述与目的、props/参数及类型与默认值、用法示例、集成模式、相关组件或模块,输出到指定路径或组件旁。
适用场景与限制:适合在开发过程中为登录模块、GraphQL API、支付模块、React 组件、Elixir 模块等生成或增强文档。规则要求生成前先阅读项目现有文档约定并匹配其风格与结构,不得暴露敏感实现细节、密钥或内部 URL,保留而非替换现有文档,包含使用真实数据的实用示例,并在适当处交叉引用相关组件和模块。