Ich möchte ein IT-Tool für den Einsatz unter Windows bereitstellen. Es handelt sich um einen ISAPI-Filter und ich möchte die Installation, den Betrieb und die Konfiguration beschreiben.
Derzeit geschieht dies in einer Textdatei, die ziemlich vollständig ist, aber ich denke, sie ist nicht sehr brauchbar. Ich denke, ich habe einen guten Überblick überWassollte in der Dokumentation enthalten sein. Ich hätte gerne Feedback zu denWieTeil. Was ist der beste Weg, Dokumentation für Windows-Webserveradministratoren bereitzustellen?
.CHM? .PDF? .DOCX? .HTM ?
BEARBEITEN: ICHhatteeine Textdatei, aber sie wurde wirklich lang und hatte nur begrenzte Möglichkeiten zum Verknüpfen, Querverweisen, Indizieren und Organisieren. Mal sehen, ein Hauptabschnitt wird mit Gleichheitszeichen unterstrichen, ein Unterabschnitt wird mit Bindestrichen unterstrichen ... usw. usw. Also habe ich versucht, es auf diese Weise zu formatieren, aber am Ende war die TXT-Datei einfach nicht skalierbar.
Aktualisieren: Ich habe SHFB ausgewählt. Hier ist dieHTML-Hilfe ausgeben. Was meint ihr? brauchbar?
Antwort1
Hier ist meine Meinung:
- ASCII-Text ist großartig – das kann ich überall lesen
- HTML ist die zweitbeste Lösung - das kann ich auch fast überall lesen
- PDF ist akzeptabel, aber etwas nervig, da ich möglicherweise auf einem Server darauf zugreifen muss, auf dem kein PDF-Reader installiert ist
- CHM ist wegen des dummen HTML-Hilfe-Steuerelements eine Qual (danke an die Fehler/Schwachstellen im HTML-Hilfe-Steuerelement!) und es ist kein sehr benutzerfreundliches Format zum Ausschneiden/Einfügen
- DOCX ist einfach nur nervig - ich habe "Office" nicht auf meinen Servern installiert und wenn ich dort auf die Dokumentation zurückgreifen muss, werde ich sie sicher nicht laden
Antwort2
Ich muss mit richtig formatierten ASCII-Textdateien arbeiten. Sie können vom Laptop, dem Server, Windows, Unix, Linux usw. gelesen werden.
Ich sollte mich nicht auf einen Webbrowser, Adobe Reader, Office oder ein anderes Programm verlassen müssen, um zu lesen, wie ich etwas auf meinem Server installiere. Es sollte einfach und schmerzlos sein.
Die Wahrheit ist ... zur Not ... könnte ich die Textdatei notfalls sogar auf meinem Mobiltelefon lesen.
Ich bin sicher, dass jeder, der schon einmal um 3 Uhr morgens unter alles andere als wünschenswerten Umständen (z. B. Anpiepen aus der Bar, kein Laptop usw.) in einer Colocation-Einrichtung festsaß, dem zustimmen würde. ;-)
Nur meine 2 Cents ...
Antwort3
Sie sollten sich ansehenasciidoc. Ich habe damit ein paar kurze Dinge gemacht und die Ausgabe ist ziemlich scharf (und natürlich anpassbar). Der reine Text ist von Natur aus sehr gut lesbar und Sie können ihn problemlos als Docbook, HTML und PDF ausgeben lassen. Mit einer beliebigen Anzahl anderer Konverter können Sie ihn auch in andere Formate wie CHM umwandeln.
Sehr vielseitiges Paket. Da es sich allerdings um ein UNIX-zentriertes Paket handelt, weiß ich nicht, wie es mit der Windows-Unterstützung aussieht.
Antwort4
Ich weiß, dass Sie bereits eine Antwort akzeptiert haben, aber ich dachte, ich würde empfehlenSphinx. Sie schreiben das Dokument in reStructuredText, können aber problemlos durchsuchbares HTML generieren (winziges JavaScript). /