Dokumentation Schreiben
Briefe schreiben ist schön
Briefe schreiben ist schön
Dokumentation
Wir haben Beschränkungen



          Inhalt


           Zeit
Wie wird Dok. geschrieben
       Ziel formulieren

    Informationen sammeln

      Infos organisieren

         Anfangen !

         Korrekturen
Wie wird Dok. geschrieben
Probleme
Probleme
Schreiber haben keine Ahnung
Probleme
Schreiber haben keine Ahnung

     Leute fühlen das !
Probleme
Schreiber haben keine Ahnung

      Leute fühlen das !

Schreiber quälen die Entwickler
Probleme
Schreiber haben keine Ahnung

      Leute fühlen das !

Schreiber quälen die Entwickler

            Lange
Probleme
Schreiber haben keine Ahnung

      Leute fühlen das !

Schreiber quälen die Entwickler

            Lange

         Viel zu lange
Probleme

schlecht geschrieben

    unorganisiert

   immer veraltet

   nie vollständig
DDD
Bullshit Bingo
DDD ?
DDD !


Documentation

Driven

Development
DDD




Wie TDD ???
3 Teile eines Programmes


       Dokumentation

          Tests

           Code
In dieser Reihenfolge


     Dokumentation

        Tests

         Code
Vorteile (Hypothese)
Vorteile (Hypothese)

 Dok. ist qualitativ besser
Vorteile (Hypothese)

D. & Code ist qualitativ besser
Vorteile (Hypothese)

 D. & Code ist qualitativ besser

(gute Programme brauchen kein D.)
Vorteile (Hypothese)

D. & Code ist qualitativ besser

 D. schreiben geht schneller
Vorteile (Hypothese)

D. & Code ist qualitativ besser

 D. schreiben geht schneller

 D. hält kein Release zurück
Vorteile (Hypothese)

D. & Code ist qualitativ besser

 D. schreiben geht schneller

 D. hält kein Release zurück

  Dok. synchron mit Code
4 Arten der externen Dok.

         Übersicht

         Tutorien

      Problemlösungen

         Referenz
Gefühl

   Übersicht

   Tutorien

Problemlösungen

   Referenz
Gefühl
Übersicht

wenige Informationen

  ungenau erklären

Assoziationen wecken

Wo ist was? (Optik!)
Lernen Durch Nachmachen

         Übersicht

         Tutorien

      Problemlösungen

         Referenz
Lernen Durch Nachmachen
Tutorial
  ganz einfach anfangen

alles Beschreiben (<Worte)

 kleine Schritte (Erfolge!)

    explain as you go

 Niveau vorher festlegen
4 Arten der externen Dok.

         Übersicht

         Tutorien

      Problemlösungen

         Referenz
Problemlösungen

    Fragen öffnen das Hirn

  Sprache wie im Programm

zweigleisig lehren, wiederholen

  Danach Absicht erklären
Knapp und Vollständig

       Übersicht

       Tutorien

    Problemlösungen

       Referenz
Dokumentation


     intern


    extern
Halte beides getrennt !


   Code (techn. Details)


      Dokumentation
Halte beides getrennt !


      für Entwickler


       für Benutzer
Unterschiedliches Format


         # (POD)


          POD
Interne Dokumentation



Kommentare in sauberen Kode (#)

  Techn. Berichte in extra .pod
Pod::Coverage



Nur für nachlässige

  Programmierer
Pod::Coverage ?
Module::Starter ?
PBP 7.2
Old School
   Ziel formulieren

Informationen sammeln

  Infos organisieren

     Anfangen !

     Korrekturen
Projekt definiert Ziel
     Ziel formulieren

 Informationen sammeln

    Infos organisieren

       Anfangen !

       Korrekturen
Hab Ich Bereits
   Ziel formulieren

Informationen sammeln

  Infos organisieren

     Anfangen !

     Korrekturen
Code und Inhalt
   Ziel formulieren

Informationen sammeln

  Infos organisieren

     Anfangen !

     Korrekturen
Data::Dumper


   Mindmaps

    Listen

    Leitern
Wo zuerst ?
   Ziel formulieren

Informationen sammeln

  Infos organisieren

     Anfangen !

     Korrekturen
Schreiberlinge gesucht
      Ziel formulieren

   Informationen sammeln

     Infos organisieren

        Anfangen !

        Korrekturen
Bücher
Dokumentation Schreiben
Dokumentation Schreiben
Danke

Document Driven Development