1

    Technical Documentation with Claude

    Enforce a 5-phase documentation workflow that verifies code reality against docs using grep and structured templates.

    Updated May 2026
    0 installs

    Free

    One-time purchase

    Included in download

    • Downloadable skill package
    • 1 permission declared
    • Instant install

    Sample Output

    A real example of what this skill produces.

    Common commands

    Build: npm run build Test: vitest run (Note: Use --runInBand for DB tests)

    Constraints

    • Do not use useSyncExternalStore in /client/components (causes hydration mismatch).
    • All secret access must go through the SecretManager wrapper, never process.env.

    About This Skill

    Stop Guessing, Start Documenting

    Most AI agents write documentation by simply paraphrasing what you tell them. This leads to "hallucinated" docs that drift from reality the moment your code changes. This skill implements a rigorous, 5-phase engineering workflow specifically designed for developer-centric documentation.

    What it does

    This skill guides your AI agent through a structured process to create high-leverage technical assets. It forces the agent to verify every technical claim against your actual source code using grep and file reads before writing a single line of prose. It supports a variety of formats including:

    • CLAUDE.md: Context-steering files that improve every future AI session.
    • Architecture Decision Records (ADR): Capturing the "why" behind complex changes.
    • Runbooks: Actionable, verified steps for incident response.
    • READMEs & API Docs: Technical guides that match actual function signatures.

    Why this is better than manual prompting

    Standard prompts often result in "docstring sprawl"—verbose text that just repeats the code's method names. This skill enforces a "Structure First" mandate via Plan Mode, ensuring you approve an outline before the agent spends tokens on prose. It prioritizes documenting intent over implementation, creating docs that actually age well.

    Use Cases

    • Generate a CLAUDE.md to keep future AI sessions on track with your conventions
    • Document architectural decisions using verified ADR templates
    • Create copy-pasteable runbooks by verifying bash commands against the repo
    • Audit existing READMEs for stale information that no longer matches the code

    Reviews

    No reviews yet - be the first to share your experience.

    Only users who have downloaded or purchased this skill can leave a review.

    Security Scanned

    Passed automated security review

    Permissions

    Terminal / Shell

    This skill is specifically optimized for **Claude Code**. It includes a CLAUDE.md template since that's Claude Code's most distinctive documentation surface (loaded into context every session), uses Plan mode for outline approval in Phase 2, and explicitly directs the agent to use Grep/Read to verify claims against the code in Phase 3 — addressing Claude's specific tendency to paraphrase the user instead of checking the repo. A Grok-flavored sibling (`technical-documentation-with-grok`) exists for agents without these specific affordances.

    Frequently Asked Questions

    Free