Quick Reference

• Who: AI Agent (via IDE)
• Where: AI Coding IDE
• Time: ~5-10 minutes
• Prerequisites: Project path, SKILL.md access

This guide is for: AI Agent Alex

Job To Be Done: Systematize codebase knowledge — “When a codebase lacks documentation, I want to generate it automatically, so that the team has a complete reference.”

File	Content	Skill
architecture.md	System overview, component diagram, ADRs	tech-docs.md
database.md	Data model, ER diagram, schema tables	tech-docs.md
deployment.md	Installation, config, hosting options	tech-docs.md
data-flow.md	Pipeline diagrams, transformation tables	tech-docs.md

graph TB

    S(["Start: analysis.md exists"])
    A["Read tech-docs.md skill"]
    B["Scan source for architecture"]
    C["Generate 4 tech doc files"]
    D["Apply content guidelines"]
    E(["4 files in docs/"])

    S --> A --> B --> C --> D --> E

The tech docs skill requires docs/analysis.md as input. Run analyze-codebase.md first if it does not exist.

Use DOC_TYPE = tech or all in the configuration prompt.

Check that each file has:

• YAML frontmatter with title, description, keywords, robots
• Quick Reference card at the top
• At least 2 Mermaid diagrams
• At least 2 internal links to other docs
• Text descriptions alongside Mermaid diagrams (LLM readability)

• 4 Markdown files in docs/
• Each file follows content-guidelines.md formatting
• Mermaid diagrams use dark-mode color palette
• All claims cite source files with line numbers

• System Architecture
• Data Flow
• Generating SOP Guides
• Customizing Templates