Generate Documentation

Create or update internal technical documentation.

Scope and Strategy

• Identify the target for documentation (Specific file, directory, component, or decision).

• Determine the appropriate artifact type:

• README.md: For directories, components, or project root.

• ADR: For architectural decisions (Architecture Decision Record).

• Guide: For "How-to" or conceptual explanations.

• Confirm the placement of the documentation (e.g., co-located with code or in a docs/ folder).

Analysis and Context

• Read the relevant source code to ensure technical accuracy.

• Identify key concepts, architectural patterns, and "gotchas".

• Review existing related documentation to ensure consistency and avoid duplication.

Draft Documentation

• Generate the documentation content using the Technical Writer persona.

• Focus:

• Explain the Why and Structure, not just the How.

• Use active voice and clear, concise English.

• Include accurate code snippets with language tags.

• Use diagrams (Mermaid) if complex relationships exist.

Verification

• Validation:

• Are all commands copy-pasteable and working?

• Do relative links point to valid files?

• Is the tone consistent with internal developer documentation?