Einführung in Docs-as-Code
Dieses Buch ist 42% vollständig
Zuletzt aktualisiert: 2019-12-06
Über das Buch
Dieses Buch hilft Ihnen bei der pragmatischenErstellung und Pflege der Dokumentation von Software.Es zeigt Ihnen, was der Docs-as-Code Ansatz ist und wie Sie ihn umsetzen und somit Ihre Dokumentation genau so behandeln, wie den Quelltext Ihrer Software.Dabei gehen wir über das einfache Verwalten von Texten mit Softwareversionierung hinaus und zeigen Ihnen, wie Sie z. B. auch Grafiken und Diagramme ohne viel Mühe aktuell haltenund Ihre Dokumentation in den Test- und Releasezyklus Ihrer Software einbinden.
Hinweis: In diesem Buch geht es nicht primär darum den Umgang mit bestimmten Tools zu vermitteln.Das Buch enthält zwar viele Beispiele und nutzt dazu das Open-Source-Projekt docToolchain.Viel wichtiger ist jedoch, dass dieses Buch den Docs-as-Code Ansatz vermittelt und Ihnen hilft eine entsprechende Denkweise und Kultur für Ihre tägliche Arbeit zu entwickeln.
Über die Autoren
Table of Contents
- 1. Einleitung
- 1.1. Für wen ist dieses Buch?
- 1.2. Für wen eignet sich der Docs-as-Code Ansatz?
- 1.3. Warum Docs-as-Code? (Motivation)
- 1.4. Übung
- 2. Docs-as-Code: der Ansatz
- 2.1. Versionierung und zentraler Speicherort
- 2.2. Gleiche Tools für Dokumentation wie für Sourcecode
- 2.3. Gehen Sie einen Schritt weiter
- 2.4. Übung
- 3. Asciidoc 101
- 3.1. Bestandteile technischer Dokumentation
- 3.2. Modulare Dokumente
- 3.3. Übung
- 4. Checkliste für Architekturdiagramme
- 4.1. Allgemein
- 4.2. Elemente des Diagramms
- 4.3. Verbindungen
- 4.4. Abstraktionslevel der Diagramme
- 4.5. Visuelle Elemente in Diagrammen
- 4.6. Übung
- 5. Anhang: Die Autoren
- 5.1. Ralf D. Müller
- 5.2. Gernot Starke
Am Ende jedes Kapitels finden Sie eine kurze Übung über die Sie das gelernte Wissen nochmals vertiefen können
Wir werden nach und nach dem Buch weitere Kapitel hinzufügen, die Sie tiefer in den Docs-as-Code Ansatz einführen
Andere Bücher dieser Autoren
Authors have earned$9,530,340writing, publishing and selling on Leanpub,
earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Erfahren Sie mehr über das Schreiben mit Leanpub
Die bedingungslose Leanpub, Kein Risiko, 100% zufrieden Garantie
Innerhalb von 45 Tagen ab Kauf kannst du dein Geld zu 100% zurückverlangen, bei jedem Leanpub-Kauf, in nur zwei Klicks. Wir bearbeiten die Erstattungen manuell, daher dauert es ein paar Tage, bis der Betrag ankommt.
Lese die kompletten Bedingungen.
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
