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, Kein Risiko, 100% zufrieden Garantie
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.
Do Well. Do Good.
Authors have earned$11,971,205writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
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, tablets, and 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
Top Books
- #1
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
- #2
A Guide To The Future Of Hospitals
Dr. Bertalan MeskoFor centuries, scientists have been trying to envision the future of hospitals. Following the recent shift towards digital health technologies, in part precipitated by COVID-19, it is natural for one to wonder how these developments will impact hospitals. What can we expect from them in the future? Will there be hospitals at all in a decade’s time?
- #3
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #4
EZ Tools Manuals
Eric Zimmerman and Andrew RathbunEric Zimmerman's Tools are free, open-source, widely taught around the world. This is the official manual for all of his command line and GUI tools.
- #5
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #6
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #7
Modern IT Automation with PowerShell
The DevOps Collective, Inc. and Michael ZanattaA PowerShell Textbook written by the community for the community!
- #8
The Rails 7 Way
Obie Fernandez, Lucas Dohmen, and Tom Henrik AadlandThe Rails™ 7 Way is the comprehensive, authoritative reference guide for professionals delivering production-quality code using modern Ruby on Rails. It illuminates the entire Rails 7 API, its most powerful idioms, design approaches, and libraries. Building on the previous editions, this edition has been heavily refactored and updated.
- #9
Aprendiendo Git
Miguel Angel Durán GarcíaGit no es complicado... ¡Si lo entiendes! 😜
¿Sientes que sabes usarlo porque has memorizado todos los comandos que necesitas? ¡Pero no entiendes qué hace cada cosa y por qué! Así es normal que, cuando exista un problema, te cueste resolverlo.
¡Con este libro vas a entender de una vez por todas todo lo que es Git y cómo sacarle provecho!
- #10
Mastering STM32 - Second Edition
Carmine NovielloWith more than 1200 microcontrollers, STM32 is probably the most complete ARM Cortex-M platform on the market. This book aims to be the most complete guide around introducing the reader to this exciting MCU portfolio from ST Microelectronics and its official CubeHAL and STM32CubeIDE development environment.
Top Bundles
- #1
Software Architecture
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #3
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #4
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #7
Statistics - All Lee Baker's Books
10 Books
This bundle includes all of the statistics books that Lee Baker has published at LeanPub 13 Statistics Books*1 PlaceNo Hassle! All in both epub and mobi formats - perfect for all devices and screen sizes. --------------------------------------------------------- *The book listed as Getting Started With Statistics is a bundle of 4 books...
