Documentation

Post Image

Codifying your documentation reorg: playbooks as the shared interface for humans and AI teammates

on restructuring engineering documentation with an AI teammate.The messy truth about restructuring engineering docs with an AI teammate - linkStitching five documentation frameworks into one coherent engineering wiki - linkYour Confluence should be a derived read model over your repo - linkCodifying your reorg: playbooks as the shared interface for humans and AI teammates - A playbook is one document. A human on their first day can read it and do the work. An AI agent, given the same document,...

Read
Post Image

Your Confluence should be a derived read model over your repo

on restructuring engineering documentation with an AI teammate.The messy truth about restructuring engineering docs with an AI teammate - linkStitching five documentation frameworks into one coherent engineering wiki - linkYour Confluence should be a derived read model over your repo - Codifying your reorg: playbooks as the shared interface for humans and AI teammates - [coming soon]Six weeks into Beacon's reorg, we opened "catalog-service - API reference" in Confluence and found a POST /variants/bulk-upsert endpoint documented in careful detail. That...

Read
Post Image

Stitching five documentation frameworks into one coherent engineering wiki

on restructuring engineering documentation with an AI teammate. 1. The messy truth about restructuring engineering docs with an AI teammate - link 2. Stitching five documentation frameworks into one coherent engineering wiki - 3. Your Confluence should be a derived read model over your repo - [coming soon] 4. Codifying your reorg: playbooks as the shared interface for humans and AI teammates - [coming soon] There is no shortage of framework retrospectives. Sequin wrote a widely-read post on how they...

Read