sc-index
Generate comprehensive project documentation and knowledge base. Use when creating docs, API documentation, project structure maps, or README files.
Install
npx skillscat add htlin222/dotfiles/sc-index Install via the SkillsCat registry.
This skill generates comprehensive project documentation, including indexes and knowledge bases, by analyzing code structure, extracting comments and existing README content, and organizing information into structured formats. It solves the problem of maintaining outdated or incomplete documentation by automating updates and ensuring consistency across project components. Use it when creating or updating documentation, API references, project structure maps, or README files to streamline knowledge management.
Project Documentation
Create and maintain comprehensive project documentation, indexes, and knowledge bases.
When to use
- Creating project documentation
- Generating API documentation
- Mapping project structure
- Creating or updating README files
- Building knowledge bases for codebases
Instructions
Usage
/sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]Arguments
target- Project directory or specific component to document--type- Documentation type (docs, api, structure, readme)--format- Output format (md, json, yaml)--update- Update existing documentation
Execution
- Analyze project structure and identify key components
- Extract documentation from code comments and README files
- Generate comprehensive documentation based on type
- Create navigation structure and cross-references
- Output formatted documentation with proper organization
Claude Code Integration
- Uses Glob for systematic file discovery
- Leverages Grep for extracting documentation patterns
- Applies Write for creating structured documentation
- Maintains consistency with project conventions
Categories
Install
npx skillscat add htlin222/dotfiles/sc-index Install via the SkillsCat registry.