| Irrlicht3D.de http://www.irrlicht3d.de/forum/ |
|
| Deutsche Dokumentation - Format http://www.irrlicht3d.de/forum/viewtopic.php?f=33&t=308 |
Seite 1 von 2 |
| Autor: | marsupial [ 29.08.2007, 16:27 ] |
| Betreff des Beitrags: | Deutsche Dokumentation - Format |
Hi, in letzter Zeit bekomme ich immer wieder Mails, in denen nach der deutschen Dokumentation gefragt wird. Deshalb wäre es vielleicht langsam an der Zet, damit zu beginnen. Ich habe vor längerer Zeit mal ein Wiki installiert, frage mich jedoch, ob das das richtige Format für eine Doku ist. Man könnte theoretisch auch einfach die Englische Doku nehmen, wie sie ist, und sie übersetzen (sodass das Format erhalten bleibt - mit Doxygen selbst habe ich noch nicht gearbeitet...) Was schlagt ihr für eine Form für die Doku vor? Am besten wäre es natürlich, wenn nicht mehr allzuviel zu programmieren wäre (Wikis gibt es ja z.B. schon sehr viele, ein eigenes System müsste erst entwickelt werden). Außerdem ist wichtig, dass alle Community-Mitglieder ohne Probleme an den Inhalten mitwirken können. Freue mich auf eure Vorschläge marsupial |
|
| Autor: | frodenius [ 29.08.2007, 16:33 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
zum letzten punkt (communitymitarbeit): ohne frage ist da das wiki der einfachste weg. |
|
| Autor: | Bubble10 [ 29.08.2007, 17:05 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
wiki wär auch übersichtlich mit suche und alles bin acuh für wiki (außerdem fällt mir sonst nix gutes ein für sowas was man nich erst entwickeln müsste) |
|
| Autor: | psyco001 [ 29.08.2007, 18:43 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
jep ich würde auch wiki sagen und wenn die doku in der wiki dann soweit fertig ist kann ich noch anbieten das ganze als Help-file zu erstellen |
|
| Autor: | thephoenix [ 29.08.2007, 18:44 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Also, Doxygen ist imho gaanz schlecht, d.h. ich wüsste nicht, warum man von der englischen Doku ausgehen sollte. Ich wäre für eine Wiki, allerdings auf jeden Fall mit einer vorgegebenen Struktur, die Schreiber einhalten sollten (1. Datei pro Seite, bestimmte Formatierung, bestimmte Regelung bei den Links etc.). Und halt organisierten Listen mit zB den Seiten, die noch Stub-Status haben, und die, die im Moment eher wichtig sind, aber noch fehlen. Und halt einer übersichtlichen in Kategorien eingeteilten Hauptseite... EDIT: Eine Liste mit deutschen Tutorials/Links etc muss auch sein. |
|
| Autor: | marsupial [ 29.08.2007, 20:13 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Ok, ich werde dann mal ein Wiki vorbereiten... Ich stelle mir den Aufbau dann so wie in der englischen Doku vor, also jede Klasse, jede Datei, jeder Namespace und jede eigenständige Funktion (also z.B. createDevice) bekommen eine eigene Seite. Ich würde dann entsprechende Übersichtsseiten vorbereiten, und wir alle würden das Wiki dann nach und nach ausfüllen. Verbesserungsvorschläge bitte posten. |
|
| Autor: | thephoenix [ 30.08.2007, 14:55 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Zitat: Verbesserungsvorschläge bitte posten. Ein großer Teil der Verbesserungen wird eh erst kommen, wenn die einzelnen Benutzer nach und nach merken, wie schrecklich das Design der Wiki ist.  Es kommt halt auch darauf an, wie viele wie stark mitarbeiten, falls dann zusätzlicher Aufand nötig wird (zB sperren von derzeit bearbeiteten Dateien von einer Person, kP, wie/mit wieviel Aufwand das Wiki-System das bereits unterstützt). Was für eine Software eigentlich? MediaWiki? |
|
| Autor: | thephoenix [ 02.09.2007, 10:26 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Zitat: in letzter Zeit bekomme ich immer wieder Mails, in denen nach der deutschen Dokumentation gefragt wird. Deshalb wäre es vielleicht langsam an der Zet, damit zu beginnen. Wäre es. Setz doch einfach mal eine Wiki auf, man sieht dann ja, wohin das führt. |
|
| Autor: | brainos [ 09.09.2007, 19:28 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Ich währe dafür das man gleich zum Anfang das Wiki komplett mit der Englischen Doku füllt, da kann man erstmal sicher sein, das alles Komplett drin ist und die Struktur kann auch gleich übernommen werden. Das Wiki-Prinip kann man dann auf die Übersetztung anwenden. Jeder übersetzt das wozu er Lust hat. Sonst bekommt man glaub ich niemal vollständigkeit in die Sache. |
|
| Autor: | Lynxeye [ 10.09.2007, 16:22 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
Ich finde die Idee von brainos gut. So ist erkennbar, das die Features dokumentiert sind und keine großen Lücken in der Doku auftauchen. Ich denke es hilft den Leuten mehr wenigstens eine englische Seite angezeigt zu bekommen, als gar nix. Und wer kein englisch versteht, kann ja immer noch hier im Forum nachfragen, und jemanden bitten es ihm zu übersetzen. Wobei man diese Übersetzung dann gleich wieder ins Wiki zurückschreiben kann. Damit dürften die wichtigen Sachen in relativ kurzer Zeit übersetzt sein. Falls dieser Vorschlag umgesetzt wird, bin ich allerding dafür, ein eigens Subforum hier einzurichten, in dem nur die Anfragen der Wikiuser gepostet werden, so das das ganze etwas übersichtlich bleibt, was nun eine Bitte um Übersetzung und was normale Fragen zu Irrlicht sind... |
|
| Autor: | thephoenix [ 10.09.2007, 17:39 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
+1. |
|
| Autor: | marsupial [ 11.09.2007, 21:36 ] |
| Betreff des Beitrags: | Re: Deutsche Dokumentation - Format |
jo, halte den Vorschlag auch für gut, aber man müsste die Übertragung halt von Hand machen... |
|
| Seite 1 von 2 | Alle Zeiten sind UTC + 1 Stunde |
| Powered by phpBB® Forum Software © phpBB Group http://www.phpbb.com/ |
|