Repository Structure¶
Why This Exists¶
This document defines the repository structure for the Algosure Blueprint and Playbook.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
A stable repository structure helps teams find content quickly, prevents misplaced decisions, and supports governed expansion of the Blueprint.
Top-Level Structure¶
| Path | Purpose |
|---|---|
docs/ |
Published MkDocs content. |
docs/00-Foundation/ |
Blueprint foundation, standards, and repository governance. |
adr/ |
Decision records. |
diagrams/ |
Diagram source files and exported assets. |
templates/ |
Reusable document templates. |
scripts/ |
Repository maintenance scripts. |
mkdocs.yml |
MkDocs configuration and navigation. |
Published Blueprint Sections¶
The published documentation uses numbered sections to preserve order.
flowchart TD
Docs[docs]
Foundation[00-Foundation]
Company[01-Company]
Practices[02-Practices]
Professionals[03-Digital-Professionals]
Capabilities[04-Business-Capabilities]
Operations[05-Operations]
AI[06-AI]
Architecture[07-Architecture]
Engineering[08-Engineering]
Docs --> Foundation
Docs --> Company
Docs --> Practices
Docs --> Professionals
Docs --> Capabilities
Docs --> Operations
Docs --> AI
Docs --> Architecture
Docs --> Engineering
Placement Rules¶
- Foundation standards belong in
docs/00-Foundation/. - Decision records belong in
adr/. - Published content belongs in
docs/. - Templates belong in
templates/. - Shared diagrams belong in
diagrams/when they are not embedded in a page.
Architecture Mirror Principle¶
As the repository expands, document placement should mirror organizational concepts. Practices, Digital Professionals, Business Capabilities, SOPs, memory, reasoning, and workflows should be represented in locations that preserve their ownership and relationships.