4. Documentation Lifecycle
Tier: All Tiers | Part: Workflow & Process
The Core Workflow
Developer → API Spec → Technical Writer → Review → GitHub → Publishing → Client
Stage Breakdown
| Stage | Your Role | Output |
|---|---|---|
| Brief & Scope | Receive brief, define scope | Signed scope of work |
| Research | Read spec, test endpoints | Research notes, gap analysis |
| Planning | Create doc map, set up files | Documentation plan |
| Writing | Write all content types | Complete first draft |
| Review | Manage feedback, revise | Approved documentation |
| Publishing | Commit to GitHub, verify | Live documentation |
| Delivery | Hand off to client | Delivered project |
NotiFlow Example
| Stage | NotiFlow Action |
|---|---|
| Brief | Engineer opens ticket: "Document POST /messages" |
| Research | Writer tests endpoint, finds 2 missing parameters |
| Writing | Writer produces 15 pages using 7Forge templates |
| Review | Senior engineer reviews, 4 corrections made |
| Publishing | Auto-published to Docusaurus site via GitHub |
| Delivery | Writer sends live URL and maintenance guide |
Checklist
- Brief received and understood
- Research complete
- Documentation plan created
- First draft complete
- Review completed
- Documentation published
- Delivery confirmed