Aktuelle Zeit: 29.03.2024, 09:11

Alle Zeiten sind UTC + 1 Stunde




Ein neues Thema erstellen Auf das Thema antworten  [ 13 Beiträge ]  Gehe zu Seite 1, 2  Nächste
Autor Nachricht
 Betreff des Beitrags: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 16:27 
Offline
Moderator

Registriert: 25.02.2007, 14:35
Beiträge: 323
Wohnort: Münster
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


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 16:33 
Offline
Moderator
Benutzeravatar

Registriert: 11.03.2007, 20:25
Beiträge: 556
Wohnort: Frankfurt/Main
zum letzten punkt (communitymitarbeit): ohne frage ist da das wiki der einfachste weg.

_________________
yo. life's so bloody short.
Ihr dachtet Schulfernsehn sei die ultimative Folter? Falsch: Fahrstuhlmusik, extra leise.


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 17:05 
Offline
Benutzeravatar

Registriert: 24.07.2007, 23:11
Beiträge: 283
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)

_________________
Be Fluffy!
kemomi.de


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 18:43 
Offline
Newsposter
Benutzeravatar

Registriert: 12.03.2007, 10:42
Beiträge: 338
Wohnort: Berlin
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


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 18:44 
Offline
Moderator
Benutzeravatar

Registriert: 15.04.2007, 20:20
Beiträge: 505
Wohnort: Reelsen
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.

_________________
Meine Gameengine :)
Bild


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 29.08.2007, 20:13 
Offline
Moderator

Registriert: 25.02.2007, 14:35
Beiträge: 323
Wohnort: Münster
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.


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 30.08.2007, 14:55 
Offline
Moderator
Benutzeravatar

Registriert: 15.04.2007, 20:20
Beiträge: 505
Wohnort: Reelsen
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?

_________________
Meine Gameengine :)
Bild


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 02.09.2007, 10:26 
Offline
Moderator
Benutzeravatar

Registriert: 15.04.2007, 20:20
Beiträge: 505
Wohnort: Reelsen
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.

_________________
Meine Gameengine :)
Bild


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 09.09.2007, 19:28 
Offline

Registriert: 16.03.2007, 03:26
Beiträge: 75
Wohnort: Dresden
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.


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 10.09.2007, 16:22 
Offline
Moderator

Registriert: 26.03.2007, 20:06
Beiträge: 114
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...


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 10.09.2007, 17:39 
Offline
Moderator
Benutzeravatar

Registriert: 15.04.2007, 20:20
Beiträge: 505
Wohnort: Reelsen
+1.

_________________
Meine Gameengine :)
Bild


Diesen Beitrag melden
Nach oben
 Profil  
 
 Betreff des Beitrags: Re: Deutsche Dokumentation - Format
BeitragVerfasst: 11.09.2007, 21:36 
Offline
Moderator

Registriert: 25.02.2007, 14:35
Beiträge: 323
Wohnort: Münster
jo, halte den Vorschlag auch für gut, aber man müsste die Übertragung halt von Hand machen...


Diesen Beitrag melden
Nach oben
 Profil  
 
Beiträge der letzten Zeit anzeigen:  Sortiere nach  
Ein neues Thema erstellen Auf das Thema antworten  [ 13 Beiträge ]  Gehe zu Seite 1, 2  Nächste

Alle Zeiten sind UTC + 1 Stunde


Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast


Du darfst keine neuen Themen in diesem Forum erstellen.
Du darfst keine Antworten zu Themen in diesem Forum erstellen.
Du darfst deine Beiträge in diesem Forum nicht ändern.
Du darfst deine Beiträge in diesem Forum nicht löschen.
Du darfst keine Dateianhänge in diesem Forum erstellen.

Suche nach:
Gehe zu:  
cron
Powered by phpBB® Forum Software © phpBB Group
Deutsche Übersetzung durch phpBB.de