Claude-skill-registry document-feature

Generate technical and user documentation for a feature

install

source · Clone the upstream repo

git clone https://github.com/majiayu000/claude-skill-registry

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/document-feature" ~/.claude/skills/majiayu000-claude-skill-registry-document-feature && rm -rf "$T"

manifest: skills/data/document-feature/SKILL.md

Document Feature: $ARGUMENTS

Generate comprehensive documentation for a feature in both developer and user-friendly formats.

Process

Phase 1: Feature Analysis

Identify feature type: Frontend, Backend, or Full-stack
Gather technical context: Files, types, dependencies, data flow
Analyze user interaction: UI elements, step-by-step journey

Search in:

/components/

/app/

/lib/

/types/

/contexts/

Phase 2: Developer Documentation

Create:

/docs/dev/$ARGUMENTS-implementation.md

IMPORTANT: Always use

/docs/

folder (not repository root) for all documentation.

Required sections:

Overview and quick reference
Architecture (component structure, data flow, types)
Implementation details (core logic, state, events)
Code examples (basic and advanced)
Testing (coverage, manual checklist)
Integration guide (config, dependencies)
API reference (if applicable)
Maintenance (known issues, future work)

Phase 3: User Documentation

Create:

/docs/user/how-to-$ARGUMENTS.md

Required sections:

Overview (what it does, benefits)
Getting started (prerequisites, access)
Step-by-step instructions with screenshot placeholders
Common use cases/scenarios
Tips and best practices (do's, don'ts, pro tips)
Troubleshooting (common problems + solutions)
FAQ
Related features

Phase 4: Screenshot List

Create:

/docs/screenshots/$ARGUMENTS-screenshots-needed.txt

List all screenshots needed with:

Filename
What to show
What to highlight

Phase 5: Cross-References

Update main documentation index
Add links to related docs
Update CLAUDE.md if new patterns introduced

Naming Conventions

Type	Pattern	Example
Dev docs	`[feature]-implementation.md`	`dark-mode-implementation.md`
User docs	`how-to-[feature].md`	`how-to-dark-mode.md`
Screenshots	`[feature]-[context].png`	`dark-mode-toggle.png`

Quality Standards

Developer docs: Technically accurate, includes file paths and line numbers, proper terminology

User docs: Non-technical language, visual aids, clear actionable steps, scannable formatting

Output Checklist

Dev doc at correct path with all sections
User doc at correct path with all sections
Screenshot placeholder list generated
Code examples syntactically correct
Cross-references added
Technical accuracy verified against code