iSAQB® Architecture Documentation (ADOC)
Documenting and communicating architectures (CPSA Advanced Level)
.svg)
Machine Learning Engineer
In this training , you training how to create and optimize architecture documentation and ensure quality in a practical manner. You will acquire knowledge of notations, tools, and methods for documenting architecture decisions and quality requirements, and you will be able to select the appropriate tools. By the end of the course, you will be able to create architecture documentation for medium to large IT systems.
Basic concepts of software architecture documentation
- Benefits, goals, and requirements of stakeholders.
- Notations (UML, BPMN) and influence of development methods.
Documentation and procedure:
- Structuring and creating architectural documentation.
- Standardized templates (arc42, C4, IEEE 1471).
Components of architectural documentation:
- Architectural decisions, architectural views, quality requirements.
- Consistency and traceability of documentation.
Tools:
- Analog and digital tools for documentation.
- Modeling tools, wikis, version control, word processing.
Evaluation of documentation:
- Review methods, checklists, quality assurance.
Examples of software architecture documentation:
- Presentation and analysis of real architectural documentation.
- Comparison of different documentation approaches.
- Discussion of the advantages and disadvantages of different documentation methods.
Requirements:
You should have basic knowledge of CPSA-F (e.g., views, design decisions, boundary conditions).
- Ideally, you already have experience in creating and maintaining technical documentation.
- You have a basic understanding of typical challenges such as selecting notations and integrating tools.
- Experience in collaborating on documentation is an advantage.
- Knowledge of versioning and documentation processes will make it easier for you to get started.
Technical requirements:
There are no special requirements for the training environment, as the exercises take place using cloud- and web-based tools such as Miro, Draw.io, and platforms such as Jupyter or HuggingFace. All that is needed is a stable and sufficiently fast internet connection.
- You will learn how to systematically document software architectures.
- You can evaluate existing documentation and improve it in specific areas.
- You take different needs into account and adapt the documentation accordingly.
- You use tools and templates (e.g., arc42, C4) for efficient creation.
- You will receive practical examples and techniques for overcoming real challenges.
- You use reviews and feedback to improve the quality of documentation.
Your advantages at a glance:
- Structured and efficient documentation: Clear and comprehensible architectural records for all stakeholders.
- Quality improvement: Improved consistency and traceability through proven methods and tools.
- Optimized collaboration: Uniform documentation standards facilitate team communication and coordination.
- Visual collaboration through, for example, whiteboarding
- High level of interactivity through customized exercises and breakout rooms
- Ideal trainer support even in the breakout rooms
Credit points for CPSA-A certification:
With the ADOC training course, you will earn 20 methodological credit points in accordance with the iSAQB Advanced Level Program.
.svg)
