FFT-Documentation - Technical Writing and Knowledge Management
Overview
Section titled “Overview”FFT-Documentation treats documentation as a first-class deliverable. It authors API references, architecture guides, tutorials, and ADR-style decision records, and it enforces FlowForge Rules #4 (Documentation Updates), #13 (living documentation), and #15 (documentation standards). Its north star: wrong docs are worse than no docs.
Capabilities
Section titled “Capabilities”- Technical writing: clear, progressive-disclosure prose tailored to the target audience.
- API documentation: OpenAPI, GraphQL schemas, WebSocket protocol docs, SDK guides.
- Architecture documentation: ADRs, C4 diagrams, sequence diagrams, component maps.
- User documentation: tutorials, how-to guides, reference, troubleshooting (Diataxis framework).
- Static site generators: Starlight, Docusaurus, MkDocs, VuePress, Sphinx.
- Diagrams as code: Mermaid, PlantUML, C4-PlantUML for version-controlled visuals.
- Documentation testing: link checking, example validation, spell checking, style linting.
- Living documentation: immediate updates when code changes, gap analysis before milestone close.
When to Use
Section titled “When to Use”- Documenting a new feature, API, or architectural decision before or during implementation.
- Authoring tutorials and getting-started guides for a new audience.
- Running a gap analysis between existing docs and the current implementation.
- Setting up or migrating a documentation site.
Example Prompts
Section titled “Example Prompts”"Write the getting-started tutorial for the new CLI that walks through install, init, and first run""Produce an ADR comparing Starlight, Docusaurus, and MkDocs for our public docs site""Run a gap analysis between PRD-007 and the implemented K.I.T.T. intelligence layer"