Software zur Dokumentation

R

RedEagle

0
Hi

Ich bin auf der Suche nach einer Möglichkeit Software, und vor allem ihre Schnittstellen und API für Module usw zu erstellen.
Speziell geht es dabei um ein Kernel für Mikrocontroller.

Programme wie Doxygen die aus dem Quellcode heraus eine Dokumentation erstellen möchte ich nicht verwenden da sie zum einen dazu verleiten zu technisch zu schreiben, und man zum anderen keine Differenzierung zwischen dem Anwender einer Software, und den Entwicklern hat. Jemand der nur die API nutzen möchte interessiert sich dafür wie die Funktionen im inneren des Systems zu verwenden sind da er kein Zugriff drauf hat.

Eine eigentlich tolle Software wäre dokuwiki. Der Vorteil liegt darin dass ich einfach Änderungen vornehmen kann und eine einfache Syntax habe. Vor allem gibt es Syntax highlighting für Beispielcodes. Der Nachteil ist natürlich dass es ohne Server&PHP nicht läuft. Der Anwender muss also zunächst einen Server einrichten um die Doku lesen zu können. Daher fallen wikis ebenfalls weg.

Gibt es vielleicht irgendwelche html/JS - Templates/Frameworks mit denen man relativ einfach etwas in HTML schreiben könnte? Für Syntax Highlighting gibt es java-scripts, aber dennoch kommt mir das etwas zu aufwändig vor…

Was nutzt ihr für Software zur Dokumentation? Welche könnt ihr empfehlen? Und was haltet ihr von der HTML/JS Lösung?
 
Man kann DokuWiki auch so einrichten, dass die Seiten als PDF exportierbar sind. Dann einfach ein kleines Skript schreiben, das z.B. sämtliche PDFs einer Kategorie exportiert und sie zusammenführt, und schon hast du eine Offline-Doku, die du zum Download bereitstellen kannst.

Alternativ kann man natürlich auch html2ps nutzen um eine Offline-Doku zu generieren.
 
html2ps kann scheinbar kein Unicode und die Darstellung ist allgemein sehr schlecht :(
Habe aber noch ein ähnliches Tool ausprobiert, wkhtmltopdf. Allerdings gibt es immer noch einige Darstellungsfehler und es werden auch leider keine Links übernommen :(

Die dokuwiki - Erweiterung werde ich mir morgen mal angucken.

Allerdings finde ich pdf - Dateien generell nicht so toll da der Platz auf ein DinA4, oder ein anderes Format, beschränkt ist. Das führt zu unschönen Zeilen- und Seitenumbrüchen. Vor allem bei Beispielcodes ist das nicht sehr schön.

Aber du hast mich auf eine Idee gebracht die ich übersehen habe :D
Ich kann ja einfach das Wiki nach html exportieren :)
Da kann man doch bestimmt irgendwie mit wget o.ä. alles von localhost runter laden…
 
Ja, mit wget sollte das problemlos gehen. Einfach mit 'wget -r URL' drüberlaufen lassen. Ggf. noch mit '-l rekursionstiefe' sicherstellen, dass nicht zu viel runtergeladen wird.
 
Um antworten zu können musst du eingeloggt sein.
Zurück
Oben