Windows 上で使用できる IT ツールを配信したいと考えています。ISAPI フィルターというツールですが、インストール、操作、設定について説明したいと思います。
現在、これはテキストファイルで行われており、かなり完成していますが、あまり使いやすくはないと思います。何ドキュメントに記載する必要があります。どうやってパート。Windows Web サーバー管理者にドキュメントを配信する最適な方法は何ですか?
.CHM? .PDF? .DOCX? .HTM?
編集： 私持っていたテキスト ファイルですが、非常に長くなり、リンク、相互参照、索引付け、整理の機能が限られていました。たとえば、主要なセクションには等号で下線が引かれ、サブセクションにはダッシュで下線が引かれます...などなど。そのため、この方法でフォーマットしてみましたが、結局、.txt ファイルは拡大縮小できませんでした。
アップデート: SHFBを選択しました。HTMLヘルプを出力するどう思いますか？使えますか？
答え1
私の見解は次のとおりです。
- ASCIIテキストは素晴らしいです。どこでも読むことができます。
- HTMLは2番目に良いです - これもほとんどどこでも読むことができます
- PDFは許容範囲ですが、PDFリーダーがインストールされていないサーバー上で参照する必要がある場合があるため、やや面倒です。
- CHMはHTMLヘルプコントロールのせいで面倒です（HTMLヘルプコントロールのバグや脆弱性のせいです！）し、切り取りや貼り付けにはあまり適したフォーマットではありません。
- DOCX は単純に面倒です。私のサーバーには「Office」がインストールされていないので、ドキュメントを参照する必要がある場合、それをロードすることは絶対にありません。
答え2
適切にフォーマットされた ASCII テキスト ファイルを使用する必要があります。これらのファイルは、ラップトップ、サーバー、Windows、Unix、Linux などから読み取ることができます。
サーバーに何かをインストールする方法を読むのに、Web ブラウザー、Adobe Reader、Office、またはその他のプログラムに頼る必要はありません。シンプルで簡単なはずです。
実のところ、いざというときには、携帯電話からテキスト ファイルを読むこともできます。
好ましくない状況 (バーから呼び出される、ノートパソコンがないなど) で午前 3 時にコロケーション施設に閉じ込められたことがある人なら、きっと同意するでしょう。 ;-)
ただ私の意見ですが...
答え3
ぜひチェックしてみてくださいアスキードキュメント. これを使って短いものをいくつか作ったことがありますが、出力はかなりシャープです (もちろんカスタマイズもできます)。プレーンテキストは設計上非常に読みやすく、docbook、HTML、PDF を簡単に出力できます。他のコンバーターを使用して、CHM などの他の形式に変換することもできます。
非常に汎用性の高いパッケージですが、UNIX 中心のパッケージであるため、Windows のサポートがどの程度であるかはわかりません。
答え4
すでに回答をいただいているのは承知していますが、スフィンクスドキュメントは reStructuredText で記述しますが、検索可能な HTML (小さな JavaScript) を簡単に生成できます。/