Skip to content

Commit 1d7da93

Browse files
committed
docs: standardize architecture diagrams
1 parent c431105 commit 1d7da93

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

docs/docs/contributing/documentation-plan.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,17 @@ environment-real-create.webm
102102

103103
Every media item must have descriptive alternative text. Videos need a written procedure that can be completed without watching them.
104104

105+
## Architecture-diagram system
106+
107+
Use the black, white, and neutral-gray visual system established by [`akoflow-control-plane.svg`](../../static/img/architecture/akoflow-control-plane.svg) for new architecture, lifecycle, and relationship diagrams. It is a reusable visual reference, not a claim that every diagram has the same topology.
108+
109+
- Use a white page or card, black rules, light-gray responsibility groups, and restrained rounded corners.
110+
- Use the checked-in AkôFlow logo rather than recreating or tracing it.
111+
- Group by responsibility, runtime boundary, or lifecycle stage; do not draw application-service cards as separate microservices unless they are independently deployed and evidenced as such.
112+
- Draw only directional arrows that communicate a real request, dispatch, observation, or ownership relationship. Keep labels beside the line rather than on top of the arrowhead.
113+
- Keep every diagram as a versioned SVG below `static/img/architecture/`, include a `<title>` and `<desc>`, and provide equivalent explanatory text in the page.
114+
- Review each new diagram in the rendered documentation at desktop and narrow widths before merging.
115+
105116
## Definition of done for a guide
106117

107118
- The task has prerequisites, Desktop steps, API steps, expected result, and next steps.

0 commit comments

Comments
 (0)