architecture-format

Solid

Standard structure and templates for Architecture documents (docs/ARCHITECTURE.md).

Code & Development 4 stars 0 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Architecture Document Structure Your architecture must contain the following sections: #### 1. Task Description Link to TASK and brief summary of requirements ### 2. Functional Architecture Description of the system in terms of functions it performs. #### 2.1. Functional Components For each functional component describe: **Component Name:** [Example, "User Management"] **Purpose:** [Why this component is needed] **Functions:** - Function 1: [Description] - Input: [what accepts] - Output: [what returns] - Related Use Cases: [UC-01, UC-03] - Function 2: [Description] - Input: [what accepts] - Output: [what returns] - Related Use Cases: [UC-02] **Dependencies:** - Depends on which other components - Which components depend on it #### 2.2. Functional Components Diagram ``` [Mermaid diagram showing connections between components] ``` ### 3. System Architecture Description of the system in terms of physical/logical components. #### 3.1. Architectural Style Which architectural pattern is used: - Monolith - Microservices - Layered Architecture - Event-driven - Etc. **Justification:** [Why this style was chosen] #### 3.2. System Components For each system component describe: **Component Name:** [Example, "User Service"] **Type:** [Backend service / Frontend / Database / Message Queue / etc.] **Purpose:** [Why needed] **Implemented Functions:** [Links to functions from functional architecture] **Technologies:** [Programming language, frameworks...

Details

Author
MatrixFounder
Repository
MatrixFounder/Agentic-development
Created
7 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category