https://github.com/iris-hunkeler/architecture-documentation

Collecting ideas and best practices to document software architecture
https://github.com/iris-hunkeler/architecture-documentation

asciidoc c4-model markdown mermaid plantuml

Last synced: 2 days ago
JSON representation

Collecting ideas and best practices to document software architecture

• Host: GitHub
• URL: https://github.com/iris-hunkeler/architecture-documentation
• Owner: iris-hunkeler
• Created: 2024-09-16T19:17:24.000Z (11 days ago)
• Default Branch: main
• Last Pushed: 2024-09-17T11:10:34.000Z (11 days ago)
• Last Synced: 2024-09-18T02:17:37.679Z (10 days ago)
• Topics: asciidoc, c4-model, markdown, mermaid, plantuml
• Homepage:
• Size: 409 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# Documenting and Communicating Software Architecture

This repository contains examples I use for talks and workshops about documentation and communication of software architecture.

The folder [C4](C4) contains diagrams of the popular [C4 model](https://c4model.com/) using [PlantUML](https://plantuml.com/) of an imaginary system called "Unicorn Webshop".

To learn how how to combine diagrams and Markdown, checkout [diagrams in Markdown](Markdown-Examples.md).

## Resources

* [C4 model](https://c4model.com/)

* [PlantUML](https://plantuml.com/) 

* [C4-PlantUML](https://github.com/plantuml-stdlib/C4-PlantUML)

* [arc42](https://arc42.org/)

* [Markdown](https://www.markdownguide.org/)

* [AsciiDoc](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/)

* [Mermaid](https://mermaid.js.org/)