SlideShare uma empresa Scribd logo
1 de 58
Baixar para ler offline
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

Mais conteúdo relacionado

Destaque

Agiles Lernen in Zeiten von zunehmender Komplexität und Digitalisierung
Agiles Lernen in Zeiten von zunehmender Komplexität und DigitalisierungAgiles Lernen in Zeiten von zunehmender Komplexität und Digitalisierung
Agiles Lernen in Zeiten von zunehmender Komplexität und DigitalisierungThomas Jenewein
 
Proyecto desarrollo de competencias comunicativas en los docentes
Proyecto desarrollo de competencias comunicativas en los docentesProyecto desarrollo de competencias comunicativas en los docentes
Proyecto desarrollo de competencias comunicativas en los docenteslaura elena aragon hope
 
Untertitelung: Eine Sonderform der Übersetzung
Untertitelung: Eine Sonderform der ÜbersetzungUntertitelung: Eine Sonderform der Übersetzung
Untertitelung: Eine Sonderform der ÜbersetzungCEG de Leipzig
 
Die Welt Dreht Sich
Die Welt Dreht SichDie Welt Dreht Sich
Die Welt Dreht Sichguestec0c28
 
CONTROL FACTOR UNIVERSUM
CONTROL FACTOR UNIVERSUMCONTROL FACTOR UNIVERSUM
CONTROL FACTOR UNIVERSUMGerold Szonn
 
Suchmaschinenoptimierung - Basics
Suchmaschinenoptimierung - BasicsSuchmaschinenoptimierung - Basics
Suchmaschinenoptimierung - BasicsMatthias Hotz
 
Praesentation Freizeitsoziologie und -psychologie
Praesentation Freizeitsoziologie und -psychologiePraesentation Freizeitsoziologie und -psychologie
Praesentation Freizeitsoziologie und -psychologieChristian Thiel
 
Erreferentzien Txostena
Erreferentzien TxostenaErreferentzien Txostena
Erreferentzien Txostenaguest239cec
 

Destaque (10)

Agiles Lernen in Zeiten von zunehmender Komplexität und Digitalisierung
Agiles Lernen in Zeiten von zunehmender Komplexität und DigitalisierungAgiles Lernen in Zeiten von zunehmender Komplexität und Digitalisierung
Agiles Lernen in Zeiten von zunehmender Komplexität und Digitalisierung
 
Proyecto desarrollo de competencias comunicativas en los docentes
Proyecto desarrollo de competencias comunicativas en los docentesProyecto desarrollo de competencias comunicativas en los docentes
Proyecto desarrollo de competencias comunicativas en los docentes
 
Untertitelung: Eine Sonderform der Übersetzung
Untertitelung: Eine Sonderform der ÜbersetzungUntertitelung: Eine Sonderform der Übersetzung
Untertitelung: Eine Sonderform der Übersetzung
 
weil
weilweil
weil
 
Die Welt Dreht Sich
Die Welt Dreht SichDie Welt Dreht Sich
Die Welt Dreht Sich
 
CONTROL FACTOR UNIVERSUM
CONTROL FACTOR UNIVERSUMCONTROL FACTOR UNIVERSUM
CONTROL FACTOR UNIVERSUM
 
Suchmaschinenoptimierung - Basics
Suchmaschinenoptimierung - BasicsSuchmaschinenoptimierung - Basics
Suchmaschinenoptimierung - Basics
 
SHOOTING SCRIPT
SHOOTING SCRIPTSHOOTING SCRIPT
SHOOTING SCRIPT
 
Praesentation Freizeitsoziologie und -psychologie
Praesentation Freizeitsoziologie und -psychologiePraesentation Freizeitsoziologie und -psychologie
Praesentation Freizeitsoziologie und -psychologie
 
Erreferentzien Txostena
Erreferentzien TxostenaErreferentzien Txostena
Erreferentzien Txostena
 

Semelhante a Document Driven Development

WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!
WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!
WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!Matthias Bohlen
 
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.Stephan Schmidt
 
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer Einstieg
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer EinstiegProgrammieren lernen Grundkurs - Tag1: 2. Theoretischer Einstieg
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer EinstiegJan Brinkmann
 
Was Sie schon immer über barrierefreie PDFs wissen wollten
Was Sie schon immer über barrierefreie PDFs wissen wolltenWas Sie schon immer über barrierefreie PDFs wissen wollten
Was Sie schon immer über barrierefreie PDFs wissen wolltenMarkus Erle
 
Stay calm & keep shipping - iOS DevCon 2013
Stay calm & keep shipping - iOS DevCon 2013Stay calm & keep shipping - iOS DevCon 2013
Stay calm & keep shipping - iOS DevCon 2013superflomo
 
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...David Decker
 
Einführung in Clean Code mit .NET - Teil 1
Einführung in Clean Code mit .NET - Teil 1Einführung in Clean Code mit .NET - Teil 1
Einführung in Clean Code mit .NET - Teil 1Gregor Biswanger
 
Kursuebersichtneu
KursuebersichtneuKursuebersichtneu
KursuebersichtneuHu Da
 
WordPress – das sind wir alle! (BarCamp Nürnberg)
WordPress – das sind wir alle! (BarCamp Nürnberg)WordPress – das sind wir alle! (BarCamp Nürnberg)
WordPress – das sind wir alle! (BarCamp Nürnberg)frankstaude
 
Workshop: Einfach besser schreiben
Workshop: Einfach besser schreibenWorkshop: Einfach besser schreiben
Workshop: Einfach besser schreibenRoger Hausmann
 
WordPress - das sind wir alle
WordPress - das sind wir alleWordPress - das sind wir alle
WordPress - das sind wir allefrankstaude
 
Vortrag 35. SEO Stammtisch Ruhrgebiet
Vortrag 35. SEO Stammtisch RuhrgebietVortrag 35. SEO Stammtisch Ruhrgebiet
Vortrag 35. SEO Stammtisch RuhrgebietBenjamin Wenderoth
 
[lectures] Projekarbeit "E-Moderation" - Drehbuch
[lectures] Projekarbeit  "E-Moderation" - Drehbuch[lectures] Projekarbeit  "E-Moderation" - Drehbuch
[lectures] Projekarbeit "E-Moderation" - DrehbuchSandra Schön (aka Schoen)
 
quäntchen + glück sucht Frontend Web Developer
quäntchen + glück sucht Frontend Web Developerquäntchen + glück sucht Frontend Web Developer
quäntchen + glück sucht Frontend Web Developerquäntchen + glück
 
Präsentationstechniken
PräsentationstechnikenPräsentationstechniken
PräsentationstechnikenKai Heller
 
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne Rundio
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne RundioDNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne Rundio
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne RundioDNX
 
Schreibblockaden flow-freundlich überwinden
Schreibblockaden flow-freundlich überwindenSchreibblockaden flow-freundlich überwinden
Schreibblockaden flow-freundlich überwindenSimon Sirch
 
Onno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellenOnno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellenlernet
 

Semelhante a Document Driven Development (20)

WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!
WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!
WJAX 2014: Pah, ArchitekturDoku, darauf habe ich keine Lust!
 
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.
23 Dinge, die Sie über Software-Entwicklung in Teams wissen sollten.
 
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer Einstieg
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer EinstiegProgrammieren lernen Grundkurs - Tag1: 2. Theoretischer Einstieg
Programmieren lernen Grundkurs - Tag1: 2. Theoretischer Einstieg
 
Was Sie schon immer über barrierefreie PDFs wissen wollten
Was Sie schon immer über barrierefreie PDFs wissen wolltenWas Sie schon immer über barrierefreie PDFs wissen wollten
Was Sie schon immer über barrierefreie PDFs wissen wollten
 
Stay calm & keep shipping - iOS DevCon 2013
Stay calm & keep shipping - iOS DevCon 2013Stay calm & keep shipping - iOS DevCon 2013
Stay calm & keep shipping - iOS DevCon 2013
 
Cathy
CathyCathy
Cathy
 
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...
WordPress sprachfähig machen - Lokalisierung Kür oder Krampf? - WordCamp Deut...
 
Einführung in Clean Code mit .NET - Teil 1
Einführung in Clean Code mit .NET - Teil 1Einführung in Clean Code mit .NET - Teil 1
Einführung in Clean Code mit .NET - Teil 1
 
Kursuebersichtneu
KursuebersichtneuKursuebersichtneu
Kursuebersichtneu
 
Froscamp2010_padre
Froscamp2010_padreFroscamp2010_padre
Froscamp2010_padre
 
WordPress – das sind wir alle! (BarCamp Nürnberg)
WordPress – das sind wir alle! (BarCamp Nürnberg)WordPress – das sind wir alle! (BarCamp Nürnberg)
WordPress – das sind wir alle! (BarCamp Nürnberg)
 
Workshop: Einfach besser schreiben
Workshop: Einfach besser schreibenWorkshop: Einfach besser schreiben
Workshop: Einfach besser schreiben
 
WordPress - das sind wir alle
WordPress - das sind wir alleWordPress - das sind wir alle
WordPress - das sind wir alle
 
Vortrag 35. SEO Stammtisch Ruhrgebiet
Vortrag 35. SEO Stammtisch RuhrgebietVortrag 35. SEO Stammtisch Ruhrgebiet
Vortrag 35. SEO Stammtisch Ruhrgebiet
 
[lectures] Projekarbeit "E-Moderation" - Drehbuch
[lectures] Projekarbeit  "E-Moderation" - Drehbuch[lectures] Projekarbeit  "E-Moderation" - Drehbuch
[lectures] Projekarbeit "E-Moderation" - Drehbuch
 
quäntchen + glück sucht Frontend Web Developer
quäntchen + glück sucht Frontend Web Developerquäntchen + glück sucht Frontend Web Developer
quäntchen + glück sucht Frontend Web Developer
 
Präsentationstechniken
PräsentationstechnikenPräsentationstechniken
Präsentationstechniken
 
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne Rundio
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne RundioDNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne Rundio
DNX Workshop ★ Einblicke in die Logoentwicklung - Yvonne Rundio
 
Schreibblockaden flow-freundlich überwinden
Schreibblockaden flow-freundlich überwindenSchreibblockaden flow-freundlich überwinden
Schreibblockaden flow-freundlich überwinden
 
Onno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellenOnno Reiners: E-Learning einfach selbst erstellen
Onno Reiners: E-Learning einfach selbst erstellen
 

Mais de lichtkind

Perl 5.20: Feature, Kultur, Module, Werkzeuge
Perl 5.20: Feature, Kultur, Module, WerkzeugePerl 5.20: Feature, Kultur, Module, Werkzeuge
Perl 5.20: Feature, Kultur, Module, Werkzeugelichtkind
 
Perl 6 in Context
Perl 6 in ContextPerl 6 in Context
Perl 6 in Contextlichtkind
 
Wx::Perl::Smart
Wx::Perl::SmartWx::Perl::Smart
Wx::Perl::Smartlichtkind
 
P6kontext2014
P6kontext2014P6kontext2014
P6kontext2014lichtkind
 
Complete Programming
Complete ProgrammingComplete Programming
Complete Programminglichtkind
 
P6 OO vs Moose (&Moo)
P6 OO vs Moose (&Moo)P6 OO vs Moose (&Moo)
P6 OO vs Moose (&Moo)lichtkind
 
Perl 5 Quiz Chemnitz Edition
Perl 5 Quiz Chemnitz EditionPerl 5 Quiz Chemnitz Edition
Perl 5 Quiz Chemnitz Editionlichtkind
 
Writing Perl 6 Rx
Writing Perl 6 RxWriting Perl 6 Rx
Writing Perl 6 Rxlichtkind
 
Wundertüte Perl
Wundertüte PerlWundertüte Perl
Wundertüte Perllichtkind
 
Perl 6 Regex und Grammars
Perl 6 Regex und GrammarsPerl 6 Regex und Grammars
Perl 6 Regex und Grammarslichtkind
 
Perl 6 Datastructures
Perl 6 DatastructuresPerl 6 Datastructures
Perl 6 Datastructureslichtkind
 
Perl 6 Datenstrukturen
Perl 6 DatenstrukturenPerl 6 Datenstrukturen
Perl 6 Datenstrukturenlichtkind
 
Modern wx perl
Modern wx perlModern wx perl
Modern wx perllichtkind
 
Bettereditors
BettereditorsBettereditors
Bettereditorslichtkind
 
Was können wir von Rebol lernen?
Was können wir von Rebol lernen?Was können wir von Rebol lernen?
Was können wir von Rebol lernen?lichtkind
 
Perl Testing
Perl TestingPerl Testing
Perl Testinglichtkind
 
Perl in der Wiki
Perl in der WikiPerl in der Wiki
Perl in der Wikilichtkind
 

Mais de lichtkind (20)

Perl 5.20: Feature, Kultur, Module, Werkzeuge
Perl 5.20: Feature, Kultur, Module, WerkzeugePerl 5.20: Feature, Kultur, Module, Werkzeuge
Perl 5.20: Feature, Kultur, Module, Werkzeuge
 
Perl 6 in Context
Perl 6 in ContextPerl 6 in Context
Perl 6 in Context
 
Wx::Perl::Smart
Wx::Perl::SmartWx::Perl::Smart
Wx::Perl::Smart
 
P6kontext2014
P6kontext2014P6kontext2014
P6kontext2014
 
Complete Programming
Complete ProgrammingComplete Programming
Complete Programming
 
P6 OO vs Moose (&Moo)
P6 OO vs Moose (&Moo)P6 OO vs Moose (&Moo)
P6 OO vs Moose (&Moo)
 
Perl 5 Quiz Chemnitz Edition
Perl 5 Quiz Chemnitz EditionPerl 5 Quiz Chemnitz Edition
Perl 5 Quiz Chemnitz Edition
 
P6oo
P6ooP6oo
P6oo
 
Writing Perl 6 Rx
Writing Perl 6 RxWriting Perl 6 Rx
Writing Perl 6 Rx
 
Wundertüte Perl
Wundertüte PerlWundertüte Perl
Wundertüte Perl
 
Perl 6 Regex und Grammars
Perl 6 Regex und GrammarsPerl 6 Regex und Grammars
Perl 6 Regex und Grammars
 
Perl 6 Datastructures
Perl 6 DatastructuresPerl 6 Datastructures
Perl 6 Datastructures
 
Perl 6 Datenstrukturen
Perl 6 DatenstrukturenPerl 6 Datenstrukturen
Perl 6 Datenstrukturen
 
Modern wx perl
Modern wx perlModern wx perl
Modern wx perl
 
Bettereditors
BettereditorsBettereditors
Bettereditors
 
Hgit
HgitHgit
Hgit
 
Was können wir von Rebol lernen?
Was können wir von Rebol lernen?Was können wir von Rebol lernen?
Was können wir von Rebol lernen?
 
Neuperl6
Neuperl6Neuperl6
Neuperl6
 
Perl Testing
Perl TestingPerl Testing
Perl Testing
 
Perl in der Wiki
Perl in der WikiPerl in der Wiki
Perl in der Wiki
 

Document Driven Development