This repository provides a comprehensive template for documenting software architecture, inspired by the original Habr article. The template is designed to help teams and organizations create clear, structured, and maintainable architecture documentation.
- Multi-language support (English, Russian, TBD...)
- Modular structure for different documentation sections
- Editable source files and Markdown versions
- Contribution guidelines for translators and editors
docs/en/- English Markdown templates for each sectiondocs/ru/- Russian Markdown templates for each sectionsource/- Original editable documents (e.g., DOCX)assets/- Diagrams and example files.github/workflows/- GitHub Actions for automation
- Clone the repository.
- Use the templates in
docs/en/ordocs/ru/to start your architecture documentation. - Refer to the CONTRIBUTING.md for contribution and translation guidelines.
This template is adapted from the article "Шаблон архитектурной документации: как и зачем оформлять архитектуру проекта" on Habr, which outlines best practices for documenting software architecture, including:
- Project context and goals
- Functional and non-functional requirements
- System decomposition and diagrams
- Integration and deployment details
- Habr article
- Google Docs src
- Local copy Habr article (PDF format)
- Local copy Google Docs doc (DOCX format)
- Local copy Google Docs doc (PDF format)
We welcome contributions! Please read CONTRIBUTING.md for details on how to submit changes or add translations.
TBD