Wenn dies dein erster Besuch hier ist, lies bitte zuerst die Hilfe - Häufig gestellte Fragen durch. Du musst dich vermutlich registrieren, bevor du Beiträge verfassen kannst. Klicke oben auf 'Registrieren', um den Registrierungsprozess zu starten. Du kannst auch jetzt schon Beiträge lesen. Suche dir einfach das Forum aus, das dich am meisten interessiert.
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.:
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 ....
Danke für den Tipp, aber das wäre in diesem Fall nicht wirklich eine Hilfe - EDOMI besteht ja aus sehr vielen unterschiedlichen Dateien, da bin ich zu Fuss schneller (schreiben muss ich ja so oder so).
EDOMI - Intelligente Steuerung und Visualisierung KNX-basierter Elektro-Installationen (http://www.edomi.de)
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.
gaert : mein letztes Projekt bestand as 7388 Dateien (habs grad mal mit dir /s zählen lassen). .c,.h,.php,.css,.html,.xml,.cpp,.hpp, .ini (ja gibts noch) usw. Das ist ja der Vorteil von Doxygen. Du legst in der Konfig fest welche Dateien er parsen soll und dann wühlt er ALLE durch. Er erstellt dir, wenn du willst, sogar abhängigkeiten der Dateien zueinander dar . Seit ich das benutze spare ich jede menge Zeit denn wenn ich für einen Fix x Dateien anfassen muss, muss ich das nicht mehr irgendwo festhalten er zeigt es automatisch an .... Einen Blick sollte dir das durchaus mal wert sein ....
Tools wie Doxygen gibt's schon ewig und die waren noch nie dafür gedacht, eine Programm-/Anwendungs-/Applikationsbeschreibung zu generieren. Doxygen kann Code prima dokumentieren, so dass ein Programmierer einfacherer nachlesen kann, was eine Funktion macht, welche Methoden definiert sind, welche Übergabewerte benötigt werden oder wie eine Klasse strukturiert ist usw.
Was damit grundsätzlich nicht geht - jedenfalls nicht, ohne dafür dann doch wieder eigene Dokumente/Dateien anzulegen - ist die Beschreibung, wie man Programmfunktionen nutzt, die mehr als eine Funktion auf Codelevel erfordern. Z.B. das Anlegen eines Benutzers in Edomi, die Tatsache, dass man für Visus getrennt Benutzer anlegen muss usw.
@gaert: Als jemand, der tagtäglich mit Dokumentation aus Doxygen & Co. hantieren muss: Bitte so weitermachen wie bisher. Ich will nicht für Edomi die Dokumentation des Sourcecodes lesen müssen, um meine Jalousien auf zu kriegen
Tools wie Doxygen wären m.M.n. hier im Edomi-Fall lediglich für die automatische Dokumentation der LBS zu gebrauchen. Und auch dort stellt sich das Problem, ob das durch die etwas spezielle Syntax innerhalb der LBS-Files überhaupt brauchbar funktioniert...
Kurzes "Update": Die Hilfe ist jetzt zu ca. 70% fertiggestellt, alles Wesentliche ist (fast) fertig - jetzt sind diverse Details und allgemeine Hilfestellungen an der Reihe. Zum Schluss werde ich dann noch die PDF-"Doku" durch eine Installationsanleitung und "Erste Schritte" ersetzen - dann geht das Update endlich raus
Zeitplan: Vermutlich noch 1-2 Wochen (maximal)...
EDOMI - Intelligente Steuerung und Visualisierung KNX-basierter Elektro-Installationen (http://www.edomi.de)
Dann nehme ich mir am besten in 1-2 Wochen nichts vor....
Wird die "Hilfe" nur eine Onlinehilfe wie in #841 zu sehen ist sein oder kann man den kompletten Inhalt auch ausdrucken...so eine Exportoption als pdf?
Markiere mir gerne Stellen entweder in OneNote bzw. oder ausgedruckt.
Gibt es auch eine Möglichkeit Texte die du neu erstellst oder veränderst zu suchen?
Zunächst wird man nur einzelne Seiten ausdrucken können (Browser) - an eine Exportfunktion der gesamten Hilfe habe ich durchaus gedacht, aber zunächst wieder verworfen: Die Hilfe ist eine Inline-Hilfe und kein Handbuch
Suchfunktion folgt noch (später), eine Versionsverwaltung werde ich mir allerdings ersparen. Falls sich etwas ändert werde ich im Changelog darauf hinweisen.
EDOMI - Intelligente Steuerung und Visualisierung KNX-basierter Elektro-Installationen (http://www.edomi.de)
Die Hilfe ist jetzt zu ca. 70% fertiggestellt, alles Wesentliche ist (fast) fertig - jetzt sind diverse Details und allgemeine Hilfestellungen an der Reihe.
Nur noch 30% und du kannst wieder von etwas anderem als Hilfetexten träumen...
Sieht vieeeel besser aus als der jetzige grüne Ring ;-)
Nur der dunkelgraue Ring um EDOMI sieht noch ein wenig, hmmm, „benachteiligt aus“ … so, du wolltest das jemand jammert
Wir verarbeiten personenbezogene Daten über die Nutzer unserer Website mithilfe von Cookies und anderen Technologien, um unsere Dienste bereitzustellen. Weitere Informationen findest Du in unserer Datenschutzerklärung.
Indem Du unten auf "ICH stimme zu" klickst, stimmst Du unserer Datenschutzerklärung und unseren persönlichen Datenverarbeitungs- und Cookie-Praktiken zu, wie darin beschrieben. Du erkennst außerdem an, dass dieses Forum möglicherweise außerhalb Deines Landes gehostet wird und bist damit einverstanden, dass Deine Daten in dem Land, in dem dieses Forum gehostet wird, gesammelt, gespeichert und verarbeitet werden.
Kommentar