⚡

项目文档生成技能Skill sc-index

该技能用于自动生成和更新项目文档，包括API文档、项目结构图、README文件等，帮助开发团队维护全面的知识库。关键词：项目文档、API文档、知识库、文档生成、软件开发工具。

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

name: sc-index description: 生成全面的项目文档和知识库。用于创建文档、API文档、项目结构图或README文件。

项目文档

创建和维护全面的项目文档、索引和知识库。

使用时机

  • 创建项目文档
  • 生成API文档
  • 映射项目结构
  • 创建或更新README文件
  • 为代码库构建知识库

指令

用法

/sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]

参数

  • target - 项目目录或要记录的特定组件
  • --type - 文档类型（docs、api、structure、readme）
  • --format - 输出格式（md、json、yaml）
  • --update - 更新现有文档

执行步骤

  1. 分析项目结构并识别关键组件
  2. 从代码注释和README文件中提取文档
  3. 根据类型生成全面的文档
  4. 创建导航结构和交叉引用
  5. 输出格式化的文档，并保持适当的组织

Claude代码集成

  • 使用Glob进行系统文件发现
  • 利用Grep提取文档模式
  • 应用Write创建结构化文档
  • 保持与项目约定的一致性