plan

Documentation Plan Generator

Create a structured documentation plan for a project, feature, or component.

Arguments

• scope (optional): What to plan documentation for
  • If omitted: Plan for entire project
  • Feature name: Plan for specific feature (e.g., "user authentication")
  • Path: Plan for specific directory (e.g., "./src/api")

Process

Step 1: Load Configuration

Read .claude/doc-master.local.md to determine documentation standard. Default to Diátaxis if not configured.

Step 2: Analyze Scope

For entire project:

1. Scan codebase structure
2. Identify major components/modules
3. Check existing documentation
4. Map what needs documenting

For specific feature:

1. Locate feature code
2. Understand feature scope
3. Identify related components
4. Determine documentation needs

For specific path:

1. Analyze code in directory
2. Identify public interfaces
3. Determine documentation requirements

Step 3: Identify Target Audiences

Ask user (if not clear from context):

• Who will read this documentation?
  • Developers using the API
  • End users of the product
  • Internal team members
  • Operations/DevOps
  • All of the above

Step 4: Gap Analysis

Compare existing documentation against needs:

• What exists and is current?
• What exists but needs updating?
• What's completely missing?
• What should be removed (outdated)?

Step 5: Generate Plan

Create documentation plan based on configured standard:

Diátaxis Plan Structure:

# Documentation Plan: [Scope]

## Overview
- Target audience: [audiences]
- Documentation standard: Diátaxis
- Estimated documents: [count]

## Tutorials (Learning-Oriented)
Priority documents to create:

### 1. Getting Started Tutorial
- **Purpose**: First-time user onboarding
- **Covers**: Installation, basic setup, first use
- **Estimated length**: 1,000-1,500 words
- **Prerequisites**: None

### 2. [Feature] Tutorial
- **Purpose**: Learn [feature] through building
- **Covers**: [topics]
- **Estimated length**: [words]
- **Prerequisites**: Getting Started

## How-To Guides (Task-Oriented)
Priority guides to create:

### 1. How to [Task]
- **Purpose**: Solve specific problem
- **Covers**: [steps]
- **Estimated length**: 500-800 words

[Additional guides...]

## Explanations (Understanding-Oriented)
Conceptual documents needed:

### 1. Architecture Overview
- **Purpose**: Explain system design
- **Covers**: Components, data flow, decisions
- **Estimated length**: 1,500-2,000 words

[Additional explanations...]

## Reference (Information-Oriented)
Reference documentation needed:

### 1. API Reference
- **Purpose**: Complete API documentation
- **Covers**: All public endpoints/methods
- **Format**: Structured reference

[Additional references...]

## Existing Documentation Status
| Document | Status | Action |
|----------|--------|--------|
| README.md | Outdated | Update |
| api.md | Missing | Create |
| setup.md | Current | Keep |

## Recommended Order
1. [First priority document]
2. [Second priority document]
...

## Timeline Suggestion
- Phase 1: Core documents (README, Getting Started)
- Phase 2: API Reference
- Phase 3: How-to guides
- Phase 4: Explanations and tutorials