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