Leanpub Header

Skip to main content
Go to Leanpub.comLeanpub

Einführung in Docs-as-Code

Endlich - Dokumentation ohne Schmerzen, entwicklerfreundlich und flexibel

Gernot Starke and Ralf D. Müller

Dokumentation für ein Software-System ist aufwändig, teuer und mach keinen Spass?

Schlechte Dokumentation ist teuer! Und dass Sie Dokumentation mit dem richtigen Ansatz leicht leicht erstellen und pflegen können, zeigen wir Ihnen in diesem Buch über den Docs-as-Code Ansatz.

The authors are letting you choose the price you pay for this book!

Pick Your Price...
PDF
438
Readers
71
Pages
About

About

About the Book

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.

Share this book

Categories

Computers and ProgrammingSoftware ArchitectureSoftware Engineering

Feedback

Email the authors

Price

Pick Your Price...

Minimum price

$7.99

$9.42

You pay

$9.42

Authors earn

$7.53
$

All prices are in US $. You can pay in US $ or in your local currency when you check out.

EU customers: prices exclude VAT, which is added during checkout.

...Or Buy With Credits!

Number of credits (Minimum 1)

1
The author will earn $12.00 from your purchase!
You can get credits monthly with a Reader Membership

Author

About the Authors

Gernot Starke

Dr. Gernot Starke (INNOQ Fellow) is co-founder and longstanding user of the (open source) arc42 documentation template. For more than 20 years, he has been working as software-architect, coach and consultant, conquering the challenges of creating effective software architectures for clients from various industries.

Gernot co-founded the International Software Architecture Qualification Board (iSAQB e.V.) and the (open source) Architecture Improvement Method (https://aim42.org).

Gernot has authored several (German) books on software architecture and related topics.

Ralf D. Müller

Ralf D. Müller is an international conference speaker, solutions architect, a ambitious Groovy developer and father. He is continually trying to simplify his work. Currently, his main concern is improving the holistic documentation of projects. He achieves this especially with the help of the arc42 template and docs-as-code approach.

He is the founder of the docToolchain open source project.

More infos about his work can be found at docs-as-co.de and on speakerdeck.

Contents

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

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

Earn $8 on a $10 Purchase, and $16 on a $20 Purchase

We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earned over $14 million writing, publishing and selling on Leanpub.

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) and 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

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub