search

howtolearn-de / howtolearn-de.github.io

Website
https://www.howtolearn.de
MIT License
0 stars 3 forks source link

TOP 5 Software Documentation #11

Open feststelltaste opened 5 years ago

feststelltaste commented 5 years ago

Let's find some resources, that really help developers and architects to document their software in the most effective ways with the least amount of time wasted!

feststelltaste commented 5 years ago

https://www.divio.com/blog/documentation/ gives a nice introduction into different types of documentation in the are of software development

feststelltaste commented 5 years ago

The book "Documenting Software Architectures" (https://www.oreilly.com/library/view/documenting-software-architectures/9780132488617/) seems like a reference for architecture documentation. But boy, who want's to read over 600 pages? :-/

feststelltaste commented 5 years ago

The arc42 project (https://arc42.org/documentation/) addresses the pains of architecture documentation by providing a lean approach. A template supports your first steps into the world of effective architecture documentation.

feststelltaste commented 5 years ago

The project around Architectural Decision Records (https://adr.github.io/) gives you advice on the bare minimum of architecture documentation: Documenting decisions that have an influence on your software system.