How to Write Better Documentation and Bring Balance to the Force

Good documentation is often the best marketing for technologies, frameworks and products: It makes complex systems more accessible, increases developer efficiency and reduces errors. However, writing documentation is often perceived as a chore, which leads to poor quality. 

In this talk, I will show you how to document with structure and clear frameworks. Firstly, we will look at types of documentation, structural standards and suitable styles. In the technical part, we'll look at how to manage extensive documentation from multiple repositories, create easily searchable pages and use linters for consistent style.

Value for the audience:
Learn How to Write More Complete, Clearer, and Higher-Quality Documentation.

Problems addressed:
What types of documentation exist, and when do I need them?

What structure is appropriate depending on the target audience?

How Do I Build a Documentation Hub?

Talk language: English
Level: Newcomer
Target group: Product Owner, Architekten

Company:
QAware GmbH

Alex Krause