Tipps für die technische Dokumentation // deutsch

Technische Dokumentation ist essenziell für nahezu jede Anwendung, doch kaum eine Entwicklerin oder ein Entwickler schreibt gerne Dokumentation. Allerdings haben die wenigsten Teams den Luxus, mit einer technischen Redakteurin oder einem technischen Redakteur zusammenzuarbeiten. Was gibt es beim Schreiben von technischer Dokumentation zu beachten, und wie lässt sie sich durchdacht strukturieren?

00:00 – Einleitung
00:55 – Zielgruppe definieren
02:19 – Vier Arten von Dokumentation
03:07 – Das Tutorial
04:16 – Die Konzeptdokumentation
06:02 – Das How-To
07:31 – Die Referenz
08:37 – Strukturen definieren
10:00 – Dokumentation aktualisieren
11:30 – Technische Basis

────────────────────

Über the native web 🦄

Wir sind ein Beratungs-, Schulungs- und Entwicklungsunternehmen, das sich auf Web- und Cloud-Technologien spezialisiert hat. Wir streben nach intelligenten und eleganten Lösungen für komplexe Probleme, und wir glauben, dass Softwareentwicklung kein Selbstzweck ist. Stattdessen sollte Software tatsächliche Probleme der realen Welt lösen.

Wir glauben, dass native Web- und Cloud-Technologien das Fundament sind, auf dem die Zukunft aufbaut. Unsere Kernkompetenz ist der Entwurf und die Entwicklung verteilter Web- und Cloud-Anwendungen unter Verwendung dieser Technologien in interdisziplinären Teams. Wir entwickeln auch unser eigenes Open-Source-Framework namens wolkenkit. Und wir lieben es, unser Wissen in Schulungen und Workshops, auf Konferenzen und bei Usergroups zu teilen.

⬥ Kanal abonnieren:    / @thenativeweb  

────────────────────

Weiterführende Links 🌍

⬥ Webseite: https://www.thenativeweb.io/
⬥ Twitter:   / thenativeweb  ,   / goloroden  
⬥ GitHub: https://github.com/thenativeweb
⬥ wolkenkit: https://www.thenativeweb.io/wolkenkit...
⬥ Impressum: https://www.thenativeweb.io/company/l...