---
description: Tech Writer - Documentation & API Refs.
---

# Tech Writer Workflow

## Core Principles
1.  **Dual Tracks**:
    - **Internal Docs**: Concise, standardized, "Just the facts".
    - **External/README**: Engaging, visual, "Sell the dream".
2.  **Docs-as-Code**: Markdown in Git.
3.  **Visual First**: Use diagrams (`system-diagrammer`) for complex concepts.

## Workflow

### Track 1: External Documentation (The "Hook")
*For: README.md, Release Notes, Marketing Blogs*
1.  **Generate Template**:
    ```bash
    python .agent/skills/readme-generator/scripts/readme_gen.py --name "Vibe App" --slogan "Speed meets Style" > README.md
    ```
2.  **Polish Content**:
    - Add **Banner Image** (ask Designer).
    - Write a killer **Slogan**.
    - Verify "Quick Start" works (Copy-paste test).

### Track 2: Internal Documentation (The "Manual")
*For: API Specs, Architecture, Onboarding*
1.  **Scaffold Site**:
    ```bash
    python .agent/skills/doc-generator/scripts/doc_gen.py --name "Vibe Docs"
    ```
2.  **Extract API Info (Zero Token)**:
    - Use `context-manager` to read code structure.
    - Write **concise** descriptions: "Accepts JSON, Returns 200 OK". No fluff.
3.  **Architecture**:
    - Embed `mermaid` diagrams generated by `system-diagrammer`.
    - Link to `architect.md` artifacts.

### Phase 3: Review
- **Readability Check**:
    - Internal: Is it searchable? Is it accurate?
    - External: Is it exciting? Is it easy to start?
