Einführung in Docs-as-Code
Einführung in Docs-as-Code
Endlich - Dokumentation ohne Schmerzen, entwicklerfreundlich und flexibel
Ü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
Inhaltsverzeichnis
- 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
Die bedingungslose Leanpub Garantie: Kein Risiko, 100% Zufriedenheit
Innerhalb von 60 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.
80% Royalties. Verdiene $16 an einem Buch für $20.
Wir zahlen 80% Tantiemen. Das ist kein Schreibfehler: Sie verdienen $16 bei einem Verkauf von $20. Wenn wir 5000 nicht zurückerstattete Exemplare Ihres Buchs oder Kurses für $20 verkaufen, verdienen Sie $80.000.
(Ja, einige Autoren haben bei Leanpub bereits viel mehr verdient.)
Tatsächlich haben Autoren durch das Schreiben, Veröffentlichen und Verkaufen auf Leanpub bereitsüber $12 Millionen verdient.
Mehr über das Schreiben auf Leanpub erfahren
Kostenlose Updates. Ohne DRM.
Mit dem Kauf auf Leanpub bekommst Du kostenlose Updates solange der Autor Änderungen vornimmt! Viele Autoren veröffentlichen ihre Bücher während des Schreibens. Alle Leser bekommen dann kostenlose Updates, egal wann sie das Buch gekauft haben oder wie viel sie bezahlt haben (auch wenn es kostenlos war).
Die meisten Leanpub Bücher sind erhältlich als PDF (für Computer) oder EPUB (für Handy, Tablet, Kindle). Die verfügbaren Formate sind oben rechts auf dieser Seite angezeigt.
Leanpub Bücher kommen ohne DRM Kopierschutz Firlefanz, sodass Du sie problemlos auf jedem unterstützten Gerät lesen kannst.
Erfahren Sie mehr über Leanpubs E-Book-Formate und wo Sie sie lesen können
