2
Windows上でITツールのドキュメントを作成して配布する方法を教えてください。私はオーサリングツールの助けにお金を費やしたくないという追加の制約があります。Windows上のITツールのドキュメントを構築して提供するにはどうすればよいですか？
ここでは、アルゴリズムと最適化、API、およびパフォーマンスについて説明します。しかし、私の開発努力の成果物の一つはドキュメンテーションです。それを構築するための最良の方法は何ですか、そしてそれをどのような形で提供すべきですか？
.NET APIのセットを提供している場合、.CHMは適切な配信メカニズムです。 SHFBを使用してヘルプファイルをビルドの一部として構築することは非常に簡単で、ほとんどがWindows上で使用される場合は.CHMに非常にアクセスできます。また、.CHMを.HTMに変換することで、ドキュメントをさらに広く利用できるようになります。
しかし、開発者自身ではなくWindows Webサーバー管理者が使用するISAPIフィルターのdocを提供したいと思います。私は、インストール、操作、および構成について説明する必要があります。エンドユーザーはしばしば開発者だけでなく管理者のスキルも持っていると思いますが、いずれにしても私の目的のためにドキュメンテーションは管理タスクと運用上の問題をカバーします。
SHFBでは、.CHMに標準のHTMLファイルを含めることができます。私がすでにSHFBを知っていて、ヘルプ作成ツールにお金を費やしたくなければ、これは最善の方法ですか？そうでなければ、何？
OO/docドキュメントはソース管理には適していません（少なくともデフォルトの保存設定ではありません）。私にとっては、これはショーストッパーです。 –
リビジョンがあるドキュメントの初期ドラフトにwikiを使用し、pdfでページをエクスポートすることができます。また、オンラインドキュメントとして残すこともできます。 –