[b3nny]

Hi,

ich habe eine Extension erstellt. Jetzt würde ich gerne ein Manual hinzufügen. Die meisten
Extensions beinhalten anscheinend eine Datei namens manual.sxw im doc/ Ver-
zeichnis. Dieses stellt dann wohl eine OpenOffice-Datei dar.

Meine Frage ist, ob es da irgendwelche OpenOffice-Templates gibt oder andere Punkte, auf
die man achten muss, wenn man ein konformes Manual erstellen möchte.

Leider habe ich darüber keine Informationen gefunden.

Gruß,
b3nny!

[mstuebner]

Zitat von b3nny

Meine Frage ist, ob es da irgendwelche OpenOffice-Templates gibt oder andere Punkte, auf die man achten muss, wenn man ein konformes Manual erstellen möchte.

Es gab zumind. mal ein Template auf typo3.org, was aber nicht wichtig ist, denn Du kannst ja ein beliebiges Manual nehmen und ausräumen.

Wichtig ist, dass Du ein wenigstens kurzes Manual schreibst und dadurch anderen die Nutzung Deiner Ext. ermöglichst. Nach meinem Gusto müssten alle Ext. ohne Manual komplett aus dem TER verschwinden, nur wäre das dann annähernd leer. ;-(

[b3nny]

Danke für die Antwort. Ein Template wäre natürlich interessant, leider habe ich es aber
nicht auf Typo3.org gefunden. Naja. Notfalls werde ich eben ein vorhandendes für meine
Extension abändern.

Und zum Punkto Dokumentation gebe ich Dir recht. Auch wenn es als Programmierer müh-
selig ist - aber 'ne Doku gehört nun mal zu einem Programm dazu, welches man ausliefert.

Sofern es um kommerzielle Anwendungen geht (das ist bei mir nicht der Fall) sind
Dokumentationen, in welcher Form auch immer, sogar Pflicht.

[aburkhart]

Zitat von b3nny

[...] Ein Template wäre natürlich interessant, leider habe ich es aber nicht auf Typo3.org gefunden[...]

Ich stand gerade vor dem gleichen Problem und wurde fündig: typo3.org: Documentation: Documentation template (available formats)

Ich gehe zwar davon aus, dass Dein Manual in der Zwischenzeit erstellt ist aber wer weiss wem dieser Link noch nützt...

Gruss
Arno

[zefix]

Das Problem ist dann aber leider, dass die Manuals teilweise schlecht gerendert werden vom Repository. Denn das übernimmt manchmal die Überschriften nicht (ich habe noch nicht raus gefunden warum) und schreibt dann lediglich als Überschrift "Extension manuals".