diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..071af7f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,33 @@ +name: "Architectural Documentation Issue" +about: "Template for creating an issue related to documenting the architecture of the project." +title: "[Architecture Docs] " +labels: documentation, architecture +assignees: '' + +--- + +### Description +Provide a detailed description of the architectural documentation that needs to be created or updated. Specify the areas of the architecture that will be covered (e.g., system overview, component diagrams, data flow). + +### Scope +Define the scope of the documentation. What specific aspects of the architecture are you focusing on? (e.g., high-level architecture, microservices, database schema, integration points). + +### Tasks +- [ ] List the tasks required to complete the documentation. +- [ ] Include steps such as creating diagrams, writing descriptions, or defining interfaces. + +### Acceptance Criteria +Clearly state the acceptance criteria to mark this issue as completed. +- [ ] Comprehensive description of the system architecture. +- [ ] Diagrams illustrating key components and their interactions. +- [ ] Explanation of key design decisions and trade-offs. + +### Resources +List any resources or references, such as existing documentation, architectural diagrams, or relevant articles. + +### Dependencies +Mention any dependencies, such as input from other team members, existing documentation, or specific tools. + +### Additional Notes +Add any additional notes or references, such as related issues, project goals, or future considerations. + diff --git a/docs/index.md b/docs/index.md index 3e841d3..cbebd75 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,10 +14,10 @@ hero: text: View the wireframe link: https://www.figma.com/proto/jHfYyjctrU6Ud5FIaAdJv4/Group-9-Low-Fidelity-Wireframe?node-id=0-1&t=QFNMCXKmwehyTaEW-1 - theme: alt - text: Arc42 + text: Arc42 Architecture Methodlogy link: https://arc42.org/overview - theme: alt - text: C4 Modelling + text: C4 Modelling Architecture Diagram Methodology link: https://c4model.com/ features: