Документация на архитектурата и структурата на Ти Броиш
Този проект съдържа самият код на документацията в Markdown и PlantUML файлове.
За да разгледате, документацията вижте генерирания сайт.
Ако искате да допринесете към документацията, вижте по-надолу.
Прочетете C4 Model за основните концепции.
Диаграмите са важна част от визуализацията и комуникацията на дадена архитектура. Но диаграмите не бива да бъдат първоизточника на информацията. Моделите трябва да са гръбнака, представящи субектите и връзките в една система - коректно и точно без възможност за объркване. Разнообразни диаграми могат да бъдат генерирани автоматично от тези модели.
Конкретни диаграми могат да бъдат създадено ръчни, за да подчертаят конкретна сфера по-добре с презентационна цел.
Спрямо Docs as Code, моделите в кода ни позволява:
- лесно да ползваме контрол на версии,
- да дискутираме предложения с прецизност при преглеждане на кода,
- да преизползваме модели на множество места.
git clone [email protected]:Da-Bulgaria/ti-broish-docs.git
cd ti-broish-docs
npm installTo build the website locally, run:
npm startOpen http://localhost:3232/.
Използваме C4Builder с C4 PlantUML, Markdown и Docsify за да генерираме йерархичеб сайт с документация от номерирани файлове.
Моля, следвайте сегашната файлова структура.
Тази документация е собственост на Политическа партия "Движение Да, България" и не може да бъде публикувана, споделянеа или модифицирана без писмено разрешение.