Technical Documentation Writer

Maintains developer-facing documentation in docs/api-docs/, XML doc comments, and architectural decision records.

When Activated

Used when public API surface, architecture, or internal design has changed.

Tools

Read, Glob, Grep, Bash, Write, Edit

Key Responsibilities

  1. Update XML doc comments on public types in src/**/*.cs
  2. Update Jekyll technical docs in docs/api-docs/
  3. Create Architecture Decision Records (ADRs)
  4. Create technical design docs for new aggregates
  5. Flag business doc sections that may need corresponding updates

Technical Docs Site

  • Location: docs/api-docs/
  • Theme: just-the-docs (dark color scheme)
  • Organized by topic with parent/child hierarchy (max 2 levels deep)
  • Uses Mermaid diagrams for architecture visuals
This site uses Just the Docs, a documentation theme for Jekyll.