Documentation Standards¶
Why This Exists¶
This standard defines how Algosure Blueprint documents must be written and reviewed.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
Consistent documentation reduces ambiguity, speeds onboarding, improves decision traceability, and keeps implementation aligned to the enterprise design.
Required Document Questions¶
Every Blueprint document must answer:
| Question | Required Answer |
|---|---|
| Why does this exist? | The purpose and reason for the document. |
| Who owns it? | The single accountable owner. |
| What business value does it create? | The measurable or strategic value created. |
Core Rules¶
- Use Markdown.
- Use YAML front matter.
- Keep each document focused on one concept.
- Assign one owner to each concept.
- Do not introduce architecture without an approved decision record or source specification.
- Use consistent terminology from the Blueprint.
- Prefer clarity over volume.
- Make draft status explicit.
One Concept, One Owner¶
Each document must describe one primary concept and identify one accountable owner. Contributors may support the document, but accountability must not be split across multiple owners.
Architecture Mirror Principle¶
Documents that describe software must show how the software mirrors Algosure's organizational design. This principle applies to Practices, Digital Professionals, Business Capabilities, SOPs, Organizational Memory, AI reasoning, and executable workflows.
Standard Page Shape¶
Use this structure unless a more specific template applies:
- YAML front matter.
- H1 title.
- Why This Exists.
- Owner.
- Business Value.
- Scope.
- Standard, process, or content body.
- Related Documents.