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
Weitere Bücher dieser Autoren
Die Leanpub 60-Tage 100% Zufriedenheitsgarantie
Innerhalb von 60 Tagen nach dem Kauf können Sie mit nur zwei Klicks eine 100% Rückerstattung für jeden Leanpub-Kauf erhalten.
Technisch gesehen ist das ein Risiko für uns, da Sie die Buch- oder Kursdateien so oder so behalten. Aber wir sind so überzeugt von unseren Produkten und Dienstleistungen sowie von unseren Autoren und Lesern, dass wir gerne eine vollständige Geld-zurück-Garantie für alles anbieten, was wir verkaufen.
Sie können nur herausfinden, wie gut etwas ist, indem Sie es ausprobieren, und dank unserer 100% Geld-zurück-Garantie gehen Sie dabei buchstäblich kein Risiko ein!
Es gibt also keinen Grund, nicht auf den 'In den Warenkorb'-Button zu klicken, oder?
Vollständige Bedingungen ansehen...
Verdienen Sie 8$ bei einem Verkauf von 10$ und 16$ bei einem Verkauf von 20$
Wir zahlen 80% Tantiemen auf Käufe von 7,99$ oder mehr und 80% Tantiemen abzüglich einer Pauschale von 50 Cent auf Käufe zwischen 0,99$ und 7,98$. Sie verdienen 8$ bei einem Verkauf von 10$ und 16$ bei einem Verkauf von 20$. Wenn wir also 5000 nicht zurückerstattete Exemplare Ihres Buches für 20$ verkaufen, verdienen Sie 80.000$.
(Ja, einige Autoren haben auf Leanpub bereits viel mehr als das verdient.)
Tatsächlich haben Autoren bereitsüber 14 Millionen Dollar durch das Schreiben, Veröffentlichen und Verkaufen auf Leanpub verdient.
Erfahren Sie mehr über das Schreiben auf Leanpub
Kostenlose Updates. DRM-frei.
Wenn Sie ein Leanpub-Buch kaufen, erhalten Sie kostenlose Updates, solange der Autor das Buch aktualisiert! Viele Autoren nutzen Leanpub, um ihre Bücher während des Schreibprozesses zu veröffentlichen. Alle Leser erhalten kostenlose Updates, unabhängig davon, wann sie das Buch gekauft oder wie viel sie bezahlt haben (einschließlich kostenloser Bücher).
Die meisten Leanpub-Bücher sind als PDF (für Computer) und EPUB (für Smartphones, Tablets und Kindle) verfügbar. Die verfügbaren Formate eines Buches werden in der oberen rechten Ecke dieser Seite angezeigt.
Schließlich haben Leanpub-Bücher keinen DRM-Kopierschutz-Unsinn, sodass Sie sie problemlos auf allen unterstützten Geräten lesen können.
Erfahren Sie mehr über Leanpubs E-Book-Formate und wo Sie sie lesen können
