Hallo Gaert,
ich weiss ja nicht wie du deine Hilfe Texte erzeugst aber hast du dir schon mal Doxygen angeschaut ??
Ich verwende das bei meinen Projekten mittlerweile ausschliesslich. Die ganze 'Doku' findet im prinzip im Sourcecode Statt. Man Dokumentiert sein Projekt und schreibt damit gleich sein Handbuch. Der Vorteil wenn man was ändert oder Bugs fixed ist das sofort dokumentiert. Man macht sich so die Arbeit nicht 2 mal. Man hat halt einmal den Initialaufwand.
Vielleicht ist das ja was für dich, und wenns nur den Changelog automatisiert ....
grüße
thomas
Ankündigung
Einklappen
Keine Ankündigung bisher.
EDOMI-Releases/Updates | Aktuell: Version 2.03
Einklappen
Dieses Thema ist geschlossen.
X
Das ist ein wichtiges Thema.
X
X
-
Noch eine Neuerung: Die Hilfe kann demnächst eigenständig in einem Extra-Browserfenster geöffnet und bedient werden - somit kann die Hilfe quasi nebenher immer geöffnet bleiben zum Nachschlagen usw.:
Bildschirmfoto 2016-05-25 um 17.16.01.png
Zuletzt geändert von gaert; 25.05.2016, 17:18.
- Likes 8
Einen Kommentar schreiben:
-
Noch ein neues Feature - die "edomi.ini" ist jetzt fast schon GUI-tauglich...
Bildschirmfoto 2016-05-23 um 23.23.37.png
- Likes 5
Einen Kommentar schreiben:
-
Zitat von gaert Beitrag anzeigenDanke - ich träume bereits Nachts von Hilfetexten
Einen Kommentar schreiben:
-
Zitat von gaert Beitrag anzeigenZielsetzung: Hilfe komplett fertig stellen - also nicht nur hier und da, sondern "vollumfänglich"...
Einen Kommentar schreiben:
-
Da hast Du vollkommen Recht - daher wird's auch höchste Zeit, dass ich mich mit der Doku/Hilfe ernsthaft auseinandersetze: Das "Aufarbeiten" der Changelogs ist die meiste Arbeit dabei. Aber wenn die Version 1.0 der Hilfe erstmal fertiggestellt ist (Stand dann EDOMI Version 1.35), werde ich jede Änderung am Code natürlich gleich in der Hilfe ergänzen. Darin habe ich durchaus Übung
Die meiste Arbeit ist also in der Tat die Aufbereitung der Vergangenheit - die Zukunft macht mir da eher weniger Sorgen
Ich bin "stets bemüht" die Hilfe so verständlich (und dennoch vollständig) wie möglich zu formulieren - es würde mich allerdings nicht sonderlich überraschen, wenn ich hier und da noch einige Änderungen vornehmen müsste
Einen Kommentar schreiben:
-
Ehrgeiziges Ziel! Wünsch dir viel Ausdauer und hoffentlich die richtigen Worte (sich in die Sicht des Neulings zu begeben, ist nicht ganz einfach. Man hat oft einfach die Experten-Brille an. Und du als Entwickler mit dem ganzen Hintergrundwissen sowieso.)
Ich habe schon oft mit viel Herzblut Dokus geschrieben. Problem ist nicht die Erstfassung, sondern das spätere, ständige Nachführen. Nach der Erstfassung ist die Doku fast perfekt (wenn man sich Mühe genommen hat) und deckt das Produkt (Programm) 1:1 ab. Aber dann kommen die vielen neuen Programmfeatures, Bugfixes etc. hinzu (gerade bei einem Edomi-Projekt, das so aktiv entwickelt wird). Eigentlich sollte man sie SOFORT nach der Implementierung auch in der Doku nachführen. Aber dazu brauchts extreme Disziplin. Und wer macht das schon. Also wird es bisschen aufgeschoben, bis man denkt, dass es sich wieder mal lohnt, an der Doku zu arbeiten. Dann ergänzt man diese...aber oh weh....nach x Wochen hat man doch nicht jede kleine neue Funktion oder Bugfix im Kopf. Und in den Release-Notes steht ja auch nicht immer jedes Detail drin. Und selbst, wenn man an jede Funktion gedacht hat, hat man auch an alle Stellen in der Doku gedacht, wo dies mal erwähnt wurde?
Ich weiss, dies ist ein Hobby-Projekt und niemand erwartet eine perfekte Hilfe. Ich möchte nur aufzeigen, dass diese Aufgabe viel Respekt verdient und nicht nur einfach dumpfe "Schreibarbeit" ist.
Aber wir freuen uns ja schon mit einer 80% Doku.
Einen Kommentar schreiben:
-
Ein paar Tage wird' schon noch dauern - ich tippe mir die Finger wund...Zielsetzung: Hilfe komplett fertig stellen - also nicht nur hier und da, sondern "vollumfänglich"...
Einen Kommentar schreiben:
-
SeatSLF
Weiss ich doch alles...bin doch auch seit der ersten Stunde dabei...sollte auch mit Ironie gelesen werden.
Ich bin nur immer gespannt und erstaunt was Christian bei jedem Update so aus dem Hut zaubert, auch wenn ich momentan zeitlich nicht alles austesten kann. Es stehen gerade Arbeiten im Galabau bei mir an.
Es ist für mich immer wie Weihnachten....vielleicht bin ich auch schon übersüchtig???Zuletzt geändert von Robby; 22.05.2016, 19:42. Grund: der hat ein Android Handy Probleme mit der Forumsoftware nach ersten Smiley war der Rest des Textes weg
Einen Kommentar schreiben:
-
Was soll uns das jetzt sagen?
Gibt es das Update bei 100%?
Wie lange hast du denn über die 5% gebraucht?
Einen Kommentar schreiben:
Einen Kommentar schreiben: