⚡

聚焦文档生成Skill sc-document

这个技能用于自动生成聚焦于特定组件、功能或API的文档，支持内联、外部、API和指南类型的文档生成，适用于代码开发、API管理、特征文档化和技术写作，关键词包括：文档生成、代码文档、API文档、聚焦文档、技术写作、文档自动化、开发辅助。

其他 0 次安装 0 次浏览 更新于 3/12/2026

name: sc-document description: 为特定组件或功能创建聚焦的文档。当用户需要代码、API或特定功能的文档时使用。

聚焦文档

为特定组件、函数或功能生成精确、聚焦的文档。

何时使用

  • 用户需要特定代码的文档
  • 需要API文档
  • 需要更新内联代码文档
  • 请求用户指南或功能文档
  • 需要特定组件的文档

说明

用法

/sc:document [target] [--type inline|external|api|guide] [--style brief|detailed]

参数

  • target - 要记录的特定文件、函数或组件
  • --type - 文档类型（内联、外部、api、指南）
  • --style - 文档风格（简洁、详细）
  • --template - 使用特定的文档模板

执行

  1. 分析目标组件并提取关键信息
  2. 识别文档需求和受众
  3. 基于类型和风格生成适当的文档
  4. 应用一致的格式和结构
  5. 与现有文档生态系统集成

Claude代码集成

  • 使用Read进行深度组件分析
  • 利用Edit进行内联文档更新
  • 应用Write进行外部文档创建
  • 维护文档标准和约定