agentleFS
Sign inStart free
WhatIfWeDigDeeperWhatIfWeDigDeeper/application-tracker/.claude/skills/document-feature/SKILL.md

document-feature

Skill1 starsChanged 9 months agoMITView on GitHub

Generate technical and user documentation for a feature

We split this skill into the rules it gives an agent

5 rules. 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Search in: /components/, /app/, /lib/, /types/, /contexts/

    line 19
  2. Very specific:

    IMPORTANT: Always use /docs/ folder (not repository root) for all documentation.

    line 25
  3. Distinctive:

    Update main documentation index

    line 62
  4. Distinctive:

    Add links to related docs

    line 63
  5. Distinctive:

    Update CLAUDE.md if new patterns introduced

    line 64

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Document Feature: $ARGUMENTS

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

Process

Phase 1: Feature Analysis

  1. Identify feature type: Frontend, Backend, or Full-stack
  2. Gather technical context: Files, types, dependencies, data flow
  3. 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:

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

Phase 3: User Documentation

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

Required sections:

  1. Overview (what it does, benefits)
  2. Getting started (prerequisites, access)
  3. Step-by-step instructions with screenshot placeholders
  4. Common use cases/scenarios
  5. Tips and best practices (do's, don'ts, pro tips)
  6. Troubleshooting (common problems + solutions)
  7. FAQ
  8. 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

TypePatternExample
Dev docs[feature]-implementation.mddark-mode-implementation.md
User docshow-to-[feature].mdhow-to-dark-mode.md
Screenshots[feature]-[context].pngdark-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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free