Skip to content

Conversation

@raifdmueller
Copy link
Owner

This PR adds a structured workshop with exercises focused on AsciiDoc for software architecture documentation.

Contents:

Exercises

  1. Setup and arc42 Template - How to initialize docToolchain and get started with arc42
  2. AsciiDoc Basics - Learning AsciiDoc syntax in the context of architecture documentation
  3. Diagrams with PlantUML and C4 - Creating professional architecture diagrams
  4. Architecture Decisions - Documenting ADRs with Pugh matrices
  5. Quality Goals and Scenarios - Creating quality trees and concrete scenarios
  6. Collaboration and CI/CD - Team workflows and automation

Additional Resources

  • References to helpful links and documentation
  • Project ideas for participants without their own project
  • Sample solution for the first exercise

Resolves docToolchain#6

The structure is designed to be easy to follow, starting with basic concepts and progressing to more advanced topics. Each exercise includes examples, explanations, and hands-on tasks with bonus challenges.

Documentation is written in AsciiDoc format to provide a practical example of what participants will be creating.

Copy link
Collaborator

@rdmueller rdmueller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bitte mal über meine Kommentare drüber schauen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants