PDA

Archiv verlassen und diese Seite im Standarddesign anzeigen : Gesucht: Dokumentation für aTuner


aths
2002-11-25, 14:29:52
Ich habe mit der Programm-Weiterentwicklung und (bekanntlich spärlichen) Web-Dokumentation genug zu tun. Schön wäre es aber auch, ein "Handbuch" zu haben. Dieses müsste:

- Auf jedem üblichen System lesbar ab Windows98 sein. Entweder reines Standard-HTML ohne kein Javascript u.ä.

- Oder PDF, oder RTF, oder Wordpad-kompatibles DOC.

- Darstellungsmäßig eher für den Drucker orientiert (= wenig Spieleien, keine Animationen, wenig Farbe)

- Zweisprachig vorliegen. (Englisch und Deutsch.)

- Inhaltlich folgendes liefern:
+ Wie benutzt man aTuner (grundlegende Funktionen)
+ Was bewirken die Optionen eigentlich?
+ Genaue Erklärung aller Buttons / Checkboxen
+ Übersichtliche und verständliche Erklärung der erweiterten Funktionen (via Links, via Konsolen-Kommandos.)
+ und was nach Meinung der Schreiber sonst noch reingehört.


Zu gewinnen gibt es nichts, so ein Handbuch würde dann lediglich auf der aTuner-Seite ebenfalls zum Download angeboten werden.

Falls sich Interessenten finden, könnten die sich hier melden. Arbeiten mehrere zusammen, ist das auch recht. Ich würde die Dokumente natürlich auf Korrektheit durchsehen. Falls irgendwelche Fragen auftauchen: Forum und Mail stehen natürlich zur Verfügung.

Ansonsten hätte ich mit diesem Handbuch direkt nichts zu tun, das Copyright besteht logischerweise beim Urheber (bzw. den Urhebern) des Dokuments.

So eine Dokumentation müsste nicht von heute auf morgen vollständig geschrieben werden. Entstünde zunächst eine deutsche Version, die später übersetzt wird, wäre das ja schon mal ein Anfang. Es steht aber erst mal die Frage, ob sich überhaupt Leute finden, die sich das aufbürden.

3dfx Voodoo5 5500
2002-11-27, 22:34:46
toll antwortet ja gar keiner, ich hab eigentlich schon bock dazu, hab aber sogut wie null html kenntnisse, und mein englisch reicht nur aus, um englisch ind deutsch zu übersetzen, umgekehrt nicht.

wie kann ich dir trotzdem behilflich sein bei der sache, weil verdient hast du es dir, so gut wie du dich programmiertechnisch um den atuner kümmerst.

also ich entschließe mich hiermit dir bei dem projekt helfen zu wollen, bloß wie das überlasse ich dir... bis demnächst

aths
2002-11-28, 14:43:20
Sehr schön.

3dfx Voodoo5 5500
2002-11-28, 16:53:49
ich werde am wochenende mal anfangen was zu schreiben, wird erstmal ein einfaches manusskript.

Andre
2002-11-28, 19:57:47
Originally posted by Wolfsheim1983
ich werde am wochenende mal anfangen was zu schreiben, wird erstmal ein einfaches manusskript.

Ich hab leider keine Zeit, selber was zu schreiben, aber wenn du Hilfe beim Übersetzen oder Korrekturlesen brauchst, mach ich das gerne.

3dfx Voodoo5 5500
2002-11-28, 21:42:14
thx, beim übersetzen werd ich dich auf jeden fall brauchen, wie gesagt kann englisch nur von eng-->deu

deut-->eng geht fast nicht.

werde das ding erstmal in word schreiben, eventuell dann als html speichern oder als pdf.

weiß ich aber noch nicht genau, wird sich am we zeigen.

GAMaus
2002-12-01, 16:06:16
Wenn das Ding fertig ist kannst Du's mir zum Uebersetzen schicken.

jambolaya@gmx.net

aths
2002-12-01, 16:07:24
Ich würde es vorher gerne sehen :)

3dfx Voodoo5 5500
2002-12-01, 16:25:34
jo klar wird erst zum aths geschickt. das prob ist dieses, ich kann es ja nicht komplett fertig machen, weil ich nicht von allemgenau weiß was Sache ist.

Wenn ich mir was nicht im klaren bin kriegst du ne pm aths.

aths
2002-12-01, 18:08:35
Ich hätte es lieber per EMail an aths@gmx.net. Danke :)

3dfx Voodoo5 5500
2002-12-05, 11:38:54
bin die woche leider total ausgeplant und muss auch arbeiten, daher komm ich leider erst am WE zum schreiben.

Hauwech
2002-12-13, 20:45:08
Hallo, helfe gerne beim Uebersetzen ins Englische. Falls da schon eine deutsche Version von Wolfsheim vorliegen sollte, natuerlich nur wenn es von aths abgesegnet wurde, einfach per mail an kmucha@gmx.de

Falls noch nix vorliegen sollte, von Wolfsheim meine ich, werde ich mich mal an den aTuner setzen und selber was kritzeln. :)

Einfach mal posten ob schon was vorliegt oder nicht :)

3dfx Voodoo5 5500
2002-12-14, 11:54:54
noch liegt nix offizielles vom mir vor, habe kaum zeit, aber dieses we und montag urlaub, da werde ich mal schauen ob ichs endlich mal schaffe.
wir können uns auch reinteilen, entweder per pm oder des "aths" willen offiziell hier im forum.

3dfx Voodoo5 5500
2002-12-14, 11:56:50
wann bringst du wieder eine offizielle version raus?
seit 1.2.4.8 sind es täglich manchmal sogar mehrere betas aber keine offizielle mehr.
die leute die sich nicht ins forum klemmen, denken eventuell du hast den support eingestellt.

aths
2002-12-14, 20:30:29
Originally posted by Wolfsheim1983
wann bringst du wieder eine offizielle version raus?Wenn die Version stabil ist und keine Fehler mehr aufweist.

mr
2002-12-23, 10:11:31
Hallo aths,

Hast Du schon mal daran gedacht ein .hlp File zu erstellen und ins Programm reinzukompilieren?
Das könnte dann auch kontextsensitiv sein (muss aber nicht).
Ein .chm (moderne html Hilfe) wäre IMO auch OK.

Nur ein Denkanstoss, denn verdient hätte es Dein "sleak Freeware Tool" auf alle Fälle.

3dfx Voodoo5 5500
2002-12-23, 20:45:10
hi aths.


wenn ich die idee meines vorredners mir so paarmal durchlese, dann fällt mir ein, du hast ja schon ne eigene doku in form der html websites.
wenn du die in atuner-stableversion integrierst wird dieses zwar etwas größer, aber der extra download für die doku würde wegfallen.


ich muss sagen, ich schaffs nicht einen ansatzpunkt für die doku zu finden, immer wenn ich losschreiben will, fällt mir kein anfang ein.
ich hab zwar schon einige sachen gesammelt um sie in den text zu integrieren aber ich krieg keinen anfang hin :(
desweiteren lese ich ja immer die betanews und teste mit, und wenn ich dann ne duko schreib, aber sich aller paar versionen sachen ändern... schwierig schrierig die sache :(

aths
2002-12-25, 23:24:52
Wenn die 1.3-er Version erst mal steht, werde ich hoffentlich auch schnell die HTML-Seiten fertig haben. Es ist geplant, ab 1.3 nicht groß mehr zu ändern.

Hast aber Recht, es macht nur bedingt Sinn, mehrere gleichartige Dokumentationen parallel laufen zu lassen. Na ich denk mir mal was aus...

aths
2002-12-25, 23:26:20
Originally posted by mr
Hallo aths,

Hast Du schon mal daran gedacht ein .hlp File zu erstellen und ins Programm reinzukompilieren?
Das könnte dann auch kontextsensitiv sein (muss aber nicht).
Ein .chm (moderne html Hilfe) wäre IMO auch OK. Überlegt tatsächlich, aber ich habe keine Tools um solche Dateien zu erstellen (muss ab Windows 98, erste Ausgabe, ohne weitere Zusätze lauffähig sein.)

Kennung1 gab mir da mal was, aber damit kam ich nicht zurecht.

3dfx Voodoo5 5500
2002-12-26, 02:32:07
hab mich mal umgeschaut und hab eine bisschen was gefunden zu dem thema

falls dich die sache wirklich interessiert, ist zwar schon älter aber es nützt vielleicht doch etwas.

Anleitung Help files für Windows + Kompilierung (http://mitglied.lycos.de/r01747391580/Wolfsheim1983/help_anleitung.pdf)



diverse helpsites1 (http://www.freewareguide.de/beta/winhelp.shtml ; )


Docfile --> hlpfile (http://www.doc-to-help.de/)



dasobere in ner älteren version ---> vielleicht was für free oder günstig (http://www.componentone.com/d2hhelp/tsupdd2h4.asp)


hoffe es hilft etwas und du kommst besser damit zurecht als mit der sache von kennung (vielleicht war das ja das was dir kennung gab ??? ich weiß es net.



edit:
das ist eher als scherz gedacht, ist ja eh vorbei :) (http://www.softexport.com/d2htrain.htm)

mr
2002-12-26, 15:46:24
Hallo aths und Wolfsheim 1983,

unter http://www.helpmaster.com findet man jede Menge Tools und Tipps für die angesprochenen Hilfeformate. Alle unten aufgeführten Tools sind über diese Homepage zugänglich.

Falls Du Dich für ein .chm entscheiden solltest (bestehende html Seiten ohne grossen Aufwand in einer professionellen Hilfe zusammenfassen), kann Ich Dir "FAR" http://www.helpware.net/FAR/index.html empfehlen.
Prinzipiell reicht der MS Help Workshop (den Du sowieso benötigst) aus, aber er ist wesentlich sperriger zu bedienen als "FAR".
"FAR" ist Shareware.


Ein .hlp ist meiner Erfahrung nach mit etwas mehr Aufwand verbunden.
Es gibt neben diversen WYSIWYG Tools, die alle mehr oder weniger gut sind, die ursprüngliche Lösung über ein .rtf das über Fußnoten dem MSHelp Compiler mitteilt wie das .hlp auszusehen hat.
Diese Variante ist sehr manuell (for beginners a PITA), es gibt aber ein gutes Tutorial namens "99Steps" damit schafft das jeder.

Wer sich einen Nachmittag intensiv mit "99Steps" .rtf --> .hlp auseinandersetzt, hat alle Voraussetzungen zur Erstellung einer Profi Hilfe.


Falls Du Deine Online Dokumentation mit einer Hilfe "mergen" möchtest, hat ein .chm folgenden Vorteil:
Die Codebase (html Seiten in diesem Fall) ist für Deine Online Dokumentation die gleiche wie für Deine Hilfe Datei. Ein nicht zu unterschätzender Vorteil bei lebendiger Software (und Dokumentation)!


Ich selbst habe mit beiden Methoden Hilfe-Dateien für unterschiedliche Anforderungen erstellt und dies sind meine Erfahrungen. Es ist gut möglich dass es für Deine Zwecke einfachere oder bessere Wege gibt, aber Ich hoffe Ich konnte helfen.

MfG
mr