JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 62
  • Score
    100M100P100Q96943F
  • License MIT

Claude Code command generator for intelligent documentation focusing on custom functionality over framework boilerplate. Reduces information overload with 70/20/10 content rule and prevents duplicate content.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@batch/claude-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @batch/claude-docs

    Complete documentation toolkit for Claude Code with specialized commands that focus on custom functionality over framework boilerplate.

    🎯 What This Does

    This package provides three specialized documentation commands that:

    • ✅ Focuses on custom business logic and unique features
    • ✅ Skips standard framework patterns that developers already know
    • ✅ Reduces information overload with 3-4 focused files max
    • ✅ Maintains universality across any project type

    🚀 Quick Start

    # Install globally
npm install -g @batch/claude-docs

# Or use directly in any project
npx @batch/claude-docs

    This installs a complete command suite in .claude/commands/ for use with Claude Code.

    📋 Usage

    1. Install the commands in your project directory: npx @batch/claude-docs
    2. Open Claude Code with your project
    3. Choose your workflow:
      • /docs-generate - Create comprehensive project documentation
      • /docs-update - Update existing docs selectively
      • /onboard - Generate developer onboarding guides
    4. Get focused documentation that highlights what makes your project unique

    🎨 What You Get

    The generated documentation emphasizes:

    • 70% Custom Business Logic - Your unique algorithms, workflows, integrations
    • 20% Modified Framework Patterns - How you've customized standard patterns
    • 10% Essential Setup - Only what's needed to get started

    📁 What You Get

    /docs-generate - Comprehensive Documentation

    • README.md - Project overview with custom feature highlights
    • DEVELOPMENT.md - Essential setup and custom workflows
    • ARCHITECTURE.md - Unique architectural decisions and WHY
    • [DOMAIN].md - Only created if substantial custom functionality exists

    /docs-update - Selective Updates

    • Intelligent analysis of what actually needs updating
    • Avoids documentation churn for minor changes
    • Focuses on developer-impacting changes only

    /onboard - Developer Onboarding

    • Step-by-step setup guide with verification steps
    • Common issues and solutions for new team members
    • Success criteria for completed onboarding

    🔄 Updating

    # Update to latest version
npm update -g @batch/claude-docs

# Then update commands in your projects
npx @batch/claude-docs

    💡 Philosophy

    Traditional documentation generators create comprehensive but overwhelming docs. This toolkit provides workflow-specific commands that help developers understand what makes your project special, not how to use React.

    Three specialized workflows:

    • Generate - Comprehensive docs for new projects or major overhauls
    • Update - Selective updates that maintain quality without churn
    • Onboard - Focused guides that get new developers productive quickly

    🤝 Contributing

    Issues and PRs welcome at batchnz/claude-docs

    📄 License

    MIT License - See LICENSE file for details