Docs

Technical documentation management plugin that maintains living documentation throughout the development lifecycle, ensuring docs stay accurate, useful, and aligned with code changes.

Plugin Target

  • Reduce documentation debt - Identify and remove outdated or duplicate documentation

  • Improve discoverability - Ensure documentation is findable when users need it

  • Maintain accuracy - Keep docs synchronized with implementation changes

  • Focus effort - Document only what provides real value to users

Focused on:

  • Living documentation - Documentation that evolves with your codebase

  • Smart prioritization - Focus on high-impact documentation that helps users accomplish real tasks

  • Automation integration - Leverage generated docs (OpenAPI, JSDoc, GraphQL) where appropriate

  • Documentation hygiene - Prevent documentation debt and bloat

Overview

The Docs plugin provides a structured approach to documentation management based on the principle that documentation must justify its existence. It implements a documentation philosophy that prioritizes user tasks over comprehensive coverage, preferring automation where possible and manual documentation where it adds unique value.

The plugin guides you through:

  • Documentation audit - Assess existing docs for freshness, accuracy, and value

  • Gap analysis - Identify high-impact documentation needs

  • Smart updates - Create or update documentation with clear purpose

  • Quality validation - Verify that examples work and links are valid

Quick Start

# Install the plugin
/plugin install docs@NeoLabHQ/context-engineering-kit

# Update project documentation after implementing features
> claude "implement user profile settings page"
> /docs:update-docs

# Focus on specific documentation type
> /docs:update-docs api

# Target specific directory
> /docs:update-docs src/payments/

Usage Examples

Commands Overview

/docs:update-docs - Documentation Update

Comprehensive documentation update command that analyzes your project, identifies documentation needs, and creates or updates documentation following best practices.

  • Purpose - Maintain accurate, useful project documentation

  • Output - Updated README files, API docs, JSDoc comments, and guides

/docs:update-docs ["target directory or documentation type"]

Arguments

Optional target specification:

  • Directory path (e.g., src/auth/) - Focus documentation updates on specific module

  • Documentation type (e.g., api, guides, readme, jsdoc) - Target specific documentation category

  • No argument - Full project documentation assessment and update

How It Works

  1. Codebase Analysis: Discovers project structure and existing documentation

    • Inventories all documentation files (README, docs/, API specs)

    • Checks for generated documentation (OpenAPI, GraphQL schemas)

    • Identifies JSDoc/TSDoc coverage

    • Maps project frameworks and tools in use

  2. User Journey Mapping: Identifies critical documentation paths

    • Developer onboarding flow

    • API consumption journey

    • Feature usage patterns

    • Troubleshooting scenarios

  3. Gap Analysis: Evaluates documentation health

    • High-impact gaps (missing setup instructions, undocumented APIs)

    • Quality assessment (freshness, accuracy, discoverability)

    • Duplication detection

    • Low-value content identification

  4. Strategic Updates: Implements prioritized improvements

    • Fixes critical onboarding blockers first

    • Updates outdated examples and broken links

    • Adds missing API examples for common use cases

    • Creates module navigation READMEs

  5. Validation: Ensures documentation quality

    • Tests code examples

    • Verifies links work

    • Confirms documentation serves real user needs

Documentation Types Updated

README Files:

  • Project root README - Quick start, overview, key links

  • Module READMEs - Purpose statement, key exports, minimal usage example

  • Feature READMEs - Navigation aid for complex feature directories

API Documentation:

  • OpenAPI/Swagger - REST API specifications from code annotations

  • GraphQL schemas - Type definitions and query documentation

  • Endpoint examples - Request/response samples with realistic data

Code Documentation:

  • JSDoc/TSDoc - Function contracts for complex business logic

  • Inline comments - Non-obvious implementation decisions

  • Type definitions - Complex interfaces and type aliases

Guides and References:

  • Getting started - Fastest path to first success

  • How-to guides - Task-oriented problem-solving docs

  • Troubleshooting - Common problems with proven solutions

  • Architecture decisions - When they affect user experience

Usage Examples

# Full project documentation update
> /docs:update-docs

# Update API documentation after adding new endpoints
> claude "add /api/v2/subscriptions endpoint"
> /docs:update-docs api

# Document a specific module after changes
> /docs:update-docs src/payments/

# Focus on README files only
> /docs:update-docs readme

# Update JSDoc comments for complex business logic
> /docs:update-docs jsdoc

Quality Gates

The command enforces documentation quality through validation:

Before Publishing:

  • All code examples tested and working

  • Links verified (no 404s)

  • Document purpose clearly stated

  • Audience and prerequisites identified

  • No duplication of generated docs

  • Maintenance plan established

Success Metrics:

  • Users complete common tasks without asking questions

  • Issues contain more bug reports, fewer "how do I...?" questions

  • Documentation is referenced in code reviews and discussions

  • New contributors can get started independently

PreviousUsage ExamplesNextUsage Examples

Last updated