Dokumentation von Extensions

RTFM – wenn denn wirklich eines da wäre… Viel zu oft trifft man auf TYPO3-Extensions – auch eigene – deren Dokumentation mit etwas Glück mager ausgefallen ist, oft aber schlicht nicht existiert. Dies ist ärgerlich, weil man dadurch im TER nur schwer abschätzen kann, ob eine vorhandene Extension die gesuchte Funktionalität bietet, und weil bei individuellen (Kunden-)Extensions nach gewisser Zeit oft Kollegen (und man selbst) auch nicht mehr so genau weiß, was die Extension tut, wie sie es tut oder warum sie es so tut.
Aber warum dokumentieren wir so wenig? Mit ein paar wenigen Schritten und mit Vorlagen erleichtern wir uns selbst, unseren Kollegen und der Community das Leben. Also auf geht’s!

In „How typo3.org works“ beschreibt Kasper Automatismen rund um die TYPO3-Plattform incl. TER. Uns interessiert hierbei insbesondere der Abschnitt „1.3. Writing documentation for TYPO3“. Dort wird erklärt, wie aus einem einfachen OpenOffice-Manual die Online-Ansichten der Manuals entstehen, und warum die Struktur und Formatierung dabei entscheidend ist.
Ein Documentation template für korrekt formatierte Manuals mit zahlreichen Hinweisen steht im TER bereit.

Es ist wirklich kein Hexenwerk. Packen wir also mal wieder unseren inneren Schweinehund, und dokumentieren unsere Extensions.

Links: