1155 proposition de

docs/_i18n/de/guide/docs-as-code.rst

@@ -0,0 +1,107 @@
+Docs as Code
+============
+
+:author: `Eric Holscher <http://ericholscher.com/>`_ & die Write-the-Docs-Community
+
+Dokumentation als Code (*Docs as Code*) bezeichnet die Auffassung, daß Dokumentation mit denselben Mitteln wie Code geschrieben werden sollte:
+
+* Ticketsystemen
+* Versionskontrolle (Git)
+* Klartext-Syntax (Markdown, reStructuredText, Asciidoc)
+* Code Reviews
+* Automatisierten Tests
+
+Es bedeutet, demselben Workflow wie Entwicklungs-Teams zu folgen
+und ins Produkt-Team eingebunden zu sein.
+Das ermöglicht ein Umfeld, in dem technische Redakteure und Entwickler gleichermaßen die Verantwortung für Dokumentation tragen
+und darin zusammenarbeiten, sie so nützlich wie möglich zu gestalten.
+
+Grundsätzlich bietet ein „Docs-as-Code“-Ansatz folgende Vorteile:
+
+* Redakteure fügen sich besser in Entwicklungs-Teams ein
+* Entwickler schreiben häufig einen ersten Dokumentations-Entwurf
+* Das Mergen neuer Features kann verhindert werden, wenn keine Dokumentation enthalten ist. Das motiviert Entwickler dazu, über Features zu schreiben, solange sie noch neu sind
+
+Es gehört mehr dazu, einen richtigen „*Docs-as-Code*“-Workflow zu aufzubauen.
+Wir empfehlen, zum Thema einige Bücher zu konsultieren:
+
+* `Docs Like Code <https://www.amazon.com/Docs-Like-Code-Anne-Gentle/dp/1387081322/>`_ - Anne Gentle
+* `Modern Technical Writing <https://www.amazon.com/Modern-Technical-Writing-Introduction-Documentation-ebook/dp/B01A2QL9SS>`_ - Andrew Etter
+
+Außerdem existitiert eine Open-Source-Toolchain, die erklärt, wie der „*Docs-as-Code*“-Ansatz umgesetzt werden kann
+
+* `docToolchain <https://doctoolchain.github.io/docToolchain/>`_
+
+.. TODO: DE
+
+*Docs as Code* at Write the Docs
+----------------------------------
+
+Write the Docs has had a number of talks that touch on this topic over the years.
+
+**2015 North America**
+
+* `Riona MacNamara`_ talked about how adopting *Docs as Code* has completely transformed how Google does documentation.
+
+**2016 North America**
+
+* We had a `panel`_ with folks from Rackspace, Microsoft, Balsamiq, and Twitter, all talking about how they are adopting these practices.
+
+**2016 Europe**
+
+* `Margaret Eker and Jennifer Roundeau`_ from Rackspace & Capital One, it was a great overview of *Docs as Code*.
+* `Rachel Whitten`_ from Pantheon give a talk on their implementation of these approaches.
+
+**2017 North America**
+
+* `Jodie Putrino`_ from F5 gave a practical account of her experience developing docs like code.
+
+**2018 Europe**
+
+* `Predrag Mandic`_ talked about how the "documentation is code" principle saves money and time, empowers documentarians, simplifies processes around testing documentation and brings happiness to a diverse customer base.
+
+**2019 Europe**
+
+* `Jen Lambourne`_ shared the UK Government Digital Service's experience adopting a docs as code approach.
+
+**2020 Europe**
+
+* `Diana Lakatos`_ showed various fully remote processes platformOS developed to help community members contribute content and code to their developer portal, including why they follow the docs as code approach, how they developed an editorial workflow that can work for all contributors, and how they implemented it through GitHub.
+
+**2021 North America**
+
+* `Swapnil Ogale`_ provided his take on transitioning from traditional tech writing tools to a docs as code approach.
+
+**2022 North America**
+
+* `Marcia Riefer Johnston and Dave May`_ from Amazon Web Services (AWS) told the story of their team's move to docs as code: what worked, what didn't, what's next.
+
+The *Docs as Code* concepts are widely practiced in the software industry,
+and are gaining adoption in the writing community.
+
+.. _Riona MacNamara: https://www.youtube.com/watch?v=EnB8GtPuauw
+.. _panel: https://www.youtube.com/watch?v=Y2TGwUPb8R4
+.. _Margaret Eker and Jennifer Roundeau: https://www.youtube.com/watch?v=JvRd7MmAxPw
+.. _Rachel Whitten: https://www.youtube.com/watch?v=dHdBsNxtKeI
+.. _Jodie Putrino: https://www.youtube.com/watch?v=Mzu-c-FoOdw
+.. _Predrag Mandic: https://www.youtube.com/watch?v=oW7rWJ2xNZU
+.. _Jen Lambourne: https://www.youtube.com/watch?v=Ql9Il7tssik
+.. _Diana Lakatos: https://www.youtube.com/watch?v=zm5Iw7jsyC4
+.. _Swapnil Ogale: https://www.youtube.com/watch?v=FQ7DkPOw3Cc
+.. _Marcia Riefer Johnston and Dave May: https://www.youtube.com/watch?v=Cxuo3udElcE
+
+*Docs as Code* at other Conferences, Video Casts and Articles
+-------------------------------------------------------------
+
+The approach has been presented at several other conferences or just video casts by different speakers.
+
+**2017**
+
+* Software Architecture Summit 2017, Berlin, Germany: Gernot Starke, Ralf D. Müller: `Hitchhiker’s Guide to Architecture Documentation <https://software-architecture-summit.de/softwarearchitektur/hitchhikers-guide-to-architecture-documentation/>`_. (Half-Day-Workshop)
+
+**2018**
+
+* I'd rather be writing: Tom Johnson: `Docs as code tools and workflows presentation <https://www.youtube.com/watch?v=Z3e_38WS-2Q>`_
+* Greach, Madrid, Spain: Ralf D. Müller: `Docs as code: arc42, AsciiDoc, Gradle & Co combined <https://www.youtube.com/watch?v=GkXpe-tZtNg>`_
+* JavaMagazin: Gernot Starke, Ralf D. Müller: `Hitchhiker’s Guide to Docs as Code <https://jaxenter.de/tag/hhgdc>`_ (German)
+* FrOSCon, Sankt Augustin, Germany: Christoph Stoettner: `Documentation with any Editor <https://media.ccc.de/v/froscon2018-2192-documentation_with_any_editor>`_