XMind

Dokumentation in OpenSource Projekten

1. Starters

   1. Qualität Codes/Dokumentation machbar

      1. http://c2.com/cgi/wiki?CodeCoverageTools

   2. Code ist zählbar

   3. Code is syntaktisch prüfbar

   4. Tests sind zählbar

   5. Tools

      1. Test::Pod

      2. Test::Pod::Coverage

      3. Pod::Coverage

      4. Devel::Cover

         1. The code

         2. Testing the tests

   6. ...aber wie verständlich ist die Dokumentation?

2. Perl

   1. (is not dead)

   2. Format der Dokumentation: Pod

   3. POD => plain old document format

   4. =head1 Ueberschrift 1 orem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. =cut

   5. POD mit perldoc gelesen

3. Mojolicious

   1. Mojolicious

   2. THE next generation webframework

   3. All glory to the hypnotoad!

   4. HTML5/hypnotoad/websockets/Async IO

   5. Programmiersprache: Perl

   6. Rapid prototyping

      1. deine Projekte

      2. das Projekt

         1. schnelle Release Zyklen

         2. Experimentals

         3. Bsp: Production Server

            1. abgekündigt

            2. entfernt

   7. Autor: Sebastian Riedel (kraih)

4. Die Entdeckung / Die Idee

   1. Webframework in Perl

   2. Dokumentation in Teilen vorhanden

   3. Entwickler Dokumnentation

   4. Wiki - rudimentär

   5. Personengruppen in dieser Phase

      1. Entwickler

      2. Contributors

      3. "Ausprobierer"

         1. wichtigste Ressource

         2. "Sie wissen nichts"

         3. "Sie können nichts"

         4. "Sie kennen die Ideeen nicht"

         5. "Sie sind hungrig"

   6. Installation eines Dokuwikis

      1. Aufschreiben der ersten Erlebnisse

      2. Fragen notieren

      3. Lösungen aus IRC / Mailingliste

   7. "Geburtsstunde" des Projektwiki

5. Evolution

   1. Framework entwickelt sich weiter

   2. ML und IRC lieferten ...

      1. Fragen

      2. Antworten

   3. Fehlentwicklungen

   4. Fehler

   5. Das Wiki entwickelte sich, ...

      1. weiter...

      2. hatte einen Doku-Chef

      3. ...wurde unübersichtlich

6. Evolution 2.0

   1. API stablisierte sich

   2. Durch Fragen und Diskussionen ...

      1. im IRC

      2. in der Mailingliste

      3. auf Twitter (#mojolicious)

   3. Überblick über ...

      1. USPs

      2. Architektur

      3. Beispielpool

      4. reale Applikationen

7. Release

   1. Übersichtskarte über das Framework (Mindmap)

   2. Wiki - voller Quellen und Beispiele

   3. Inline Dokumentation verbessert

   4. Hinterhalte in der Mailingliste

8. Ausschnitte

   1. Mojo Wiki

   2. inline Dokumentation

9. Tipps / Tricks / Tools / Fails

   1. Fehlende Vision

      1. Designideen

      2. Überblick

      3. TODO

   2. Trennen von Doku / Code

      1. wiki

      2. github wiki

         1. Probleme: Jeder kann zugreifen

         2. Klammerfunktion

         3. use Pod; # Offline Verwendung

      3. Übersetzungen sind sehr aufwändig

   3. Verlinkung

      1. Verlinkung ineinander

      2. Automatische Verlinkung

      3. "redaktionelle Verlinkung"

      4. meßbar machen, darstellen

         1. Graphviz

   4. Projekt Ressourcen

      1. Blogs

         1. *ugh* Japanese in English

      2. #twitter

         1. FollowBot

         2. use lists;

         3. Retweet Tweets

         4. Post Tweets #IRC

         5. Daily Newsletter (Times) an die ML

         6. Google ist dein Freund

      3. IRC

         1. Evangelisten

         2. Wieviele Leute sind regelmässig dabei

      4. Mailingliste

         1. Evangelisten

         2. Wiviele Leute sind regelmässig dabei

   5. Tools sind Tools

      1. Entwickler mögen ...

      2. Anwender mögen ...

      3. ...

   6. Challenge me, I'll fix it.

10. Danke :) (rhaen@fcntl.de)