-
Notifications
You must be signed in to change notification settings - Fork 0
Home
{{
Provide your own short description about your wiki, and the related project here.
}}
[[
Repository template to manage a GitHub wiki that is synchronized with another GitHub project.
This wiki is synchronized with the project-repo-template.
The structure is loosely related to the arc42 documentation.
To create system models, you should take a look at C4, and the related Structurizr DSL.
This template is tailored to GitHub repositories, but the core concepts work for any project using a version control system.
A short overview on how to use this wiki is given in README.md.
]]
- Introduction and Goals
- Constraints
- Context and Scope
- Core and Shared Concepts
- Requirements
- Quality Assurance
- Decision Records
- Risk and Technical Debt
- Views
- Exchanges
- Templates
- Glossary
{{
Give a short introduction about the project.
}}
{{
List and link to the most impactful 10 to 20 requirements of the system.
}}
{{
List the 10 to 20 most important quality goals of the system.
}}
{{
List and briefly describe the identified stakeholders of the system.
Note: You might want to create a persona section, and link stakeholders to specific personas.
}}
{{
Footer that is displayed on every wiki page
}}
[[
Please create an issue if you found any spelling mistakes.
You may also create an issue if you think the content of this wiki should be improved.
Note: This wiki is managed in its own repository. Any commits made using the edit button will be overwritten.
Note: Issues for the wiki are handled in the project-repo-template, but pull requests for the wiki are handled in the project-wiki-template.
This wiki is MIT licensed, and works together with the project-repo-template. Serving as template repositories for new GitHub projects.
]]