Actions

2008-07-23 DanielMartijnSebastianSteffenSusanneVirgil Wednesday 1830 GMT+2 via skype

Datum: 23.07.2008

Participants:

Daniel Bruessler, Martijn, Sebastian Kurfürst, Steffen Kamper, Susanne Moog, Virgil Huston

Topics:

Ratings:

  • It should be possible to rate the manuals to judge
    o ... which manuals are most important
    o ... which manuals should be rewritten
  • Ratings for single parts, so that it is clear, which parts should be redone
  • second thoughts on the stars for ratings: some people just click because it's nice to click :) --> perhaps radio buttons with "perfect", "well...", "bah" or something like that
  • additionally it would be nice to add comments to the ratings so that people can tell, what exactly should be changed
  • rating should be possible directly on the manual pages so that the user does not have to leave the page he is on
  • example for new documentation structure with comments: http://support.typo3.org/documentation/tsref/ (contact: Steffen Kamper)

new documentation structure, new documentation editor

  • sample structure consists of TYPO3 pages
  • for version 5.0: default is docboox, so this should be acknowledged in all decisions we make now
  • docBook advantages:
    o all manuals already exist as docbook
    o there is already a docbook to PDF filter (and many more, it's easy because docBook is just plain XML)
    o SVN access and control, diffs / patches for manuals possible etc.
    + --> all SVN advantages, like history, concurrent access, etc.
  • for TYPO3 in combination with docBook: is there an extension for SVN access?
  • new URL structure like on http://support.typo3.org/documentation/tsref/ for syntax highlighting (e.g.: http://www.steffenkamper.info/trunk/index.php?id=93) to work
  • Steffen and Daniel will look how to organize everything best (check what is easier to use for editing manuals online and make them ready for TER)
  • PHP.net uses docbook for their website, HowTo: http://doc.php.net/php/dochowto/index.php
  • another question: is there a good and easy to use editor for docbook files?

new domain:

  • documentation.typo3.org --> all documentation will be found here in the future
  • we'll first stick to support.typo3.org as that is already there and nice for testing purposes

subprojects:

  • It is possible to generate subprojects of subprojects, but we don't know how yet. So let's find out.

TS45Minutes:

  • no timeline until now
  • perhaps we should at least have milestones?

[GERMAN:]

Teilnehmer:

Daniel Bruessler, Martijn, Sebastian Kurfürst, Steffen Kamper, Susanne Moog, Virgil Huston

Themen:

Ratings:

  • Es soll möglich sein, die Dokumentation zu bewerten, um damit feststellen zu können,...
    • ... welche Manuals am wichtigsten sind
    • ... welche Manuals am dringendsten erneuert werden müssen
  • Ratings für einzelne Kapitel, damit genauer gesehen werden kann, welche Teile unklar sind
  • Bedenken, wegen der Sterne: manche klicken einfach nur weil's so schön ist :) --> Vielleicht Radio-Buttons mit Auswahlmöglichkeiten "perfekt", "naja", "mist" oder so
  • zusätzlich zum reinen Rating noch eine Kommentarfunktion: Damit auch gesagt werden kann, was geändert werden soll
  • Rating sollte direkt auf den Manual-Seiten möglich sein, so dass der Benutzer die Seite nicht verlassen muss
  • Beispielstruktur für neue Dokumentation mit Rating und Kommentaren: http://support.typo3.org/documentation/tsref/ (Ansprechpartner: Steffen Kamper)

neue Dokumentationsstruktur / neuer Dokumentationseditor

  • Beispielstruktur ist über TYPO3-Seiten realisiert
  • für Version 5.0: Standardformat ist docbook, daher wäre es sinnvoll, das jetzt schon mit einzubeziehen
  • docBook Vorteile:
    • alle Manuals existieren ohnehin schon als docBook
    • docbook nach PDF gibt es schon als Filter (generell viele Filter vorhanden, da XML-Format)
    • SVN-Zugriff und Kontrolle, diffs / patches für Manuals möglich etc.
      • --> dadurch generelle SVN-Vorteile, wie history, parallele Zugriffe, etc.
  • für TYPO3 in Kombination mit docBook interessant: gibt es Extension für SVN-Zugriffe?
  • neue URL-Struktur wie auf http://support.typo3.org/documentation/tsref/ damit Syntax-Highlighting wie hier http://www.steffenkamper.info/trunk/index.php?id=93 funktionieren kann
  • Steffen und Daniel schauen mal, wie das ganze weiter organisiert werden soll (überprüfen was sich erstmal leichter verwenden lässt um manuals online zu bearbeiten und fürs TER bereit zu machen)
  • PHP.net verwendet auch docbook für ihre Website, siehe HowTo: http://doc.php.net/php/dochowto/c78.php
  • weitere Frage: gibt es guten Editor für docBook (DAU-freundlich?)

neue Domain:

  • documentation.typo3.org --> alle documentation-Sachen sollen in Zukunft hier drauf
  • zunächst aber noch auf support, zum Testen, weil schon vorhanden

subprojects:

  • Es ist generell möglich auf forge Subprojekte von Subprojekten anzulegen. Ist nur die Frage wie... wird als Issue eingestellt

TS45Minutes:

  • bisher keine Timeline vorhanden
  • vielleicht zumindest Meilensteine?

Updated by Daniel Brüßler over 13 years ago · 6 revisions