基本的なリクエストは次のとおりです。
ある種の wiki エンジンを使用することを考えていますが、ストレージにファイルを使用するか、顧客への「展開」の他の手段が必要であり、インストール/メンテナンスが簡単である必要があります。また、無料/安価である必要があります（合流点は高すぎます）
助言がありますか？
編集: コードを文書化するためのツールを探しているわけではありません。Sandcastle を使用してカバーしています。
すべての要求に答えることはできないかもしれませんが、DokuWikiは一見の価値があるかもしれません。
他のウィキと同様に、構文は単純で、リビジョンを追跡するためのバージョン管理、目次の生成、およびヘルプシステムに役立つ全文検索機能を備えています。
機能リストを評価して、ニーズを満たすかどうかを確認することをお勧めします。
また、利用可能なプラグインの優れたコレクションもあるようです。DokuWikiまたはそのプラグインは使用していませんが、 PDFエクスポートに使用できるプラグインもあるようです。
APIには、Doxygenを使用しています。これはすばらしいことです。
私はAsciidocについて十分に良いことを言うことはできません. それは非常に単純なマークアップ構文を持ち、pdf から roff まですべてを生成でき、実装するために移植可能であり、わずかな変更を加えるだけで任意の wiki に非常に簡単に挿入できます。
マークアップ状態であっても、非常に読みやすいです。使用時にいじる必要があるのはテーブルだけですが、それほど難しくありません。
テキスト形式のファイルをリポジトリに保持すると、リビジョンの追跡は非常に簡単になります。
コードのドキュメントには、doxygenを使用します。
マニュアルとヘルプファイルにはヘルプとマニュアルを使用します。htmlエクスポートはありませんが、htmlヘルプ、winhelp、pdf、およびその他のいくつかの形式を提供します。
Sphinxを試してください。すべてのPythonドキュメントは、このツールhttp://docs.python.org/を使用して作成されています。
ウィキを使用しています。モインモインをおすすめする理由
次の理由により、Word などは使用していません。
使用している言語/フレームワークについては言及していません。非常に優れたドキュメンテーション ツールがありますが、開発しているツールに固有のものもあります。
無料であるだけでなく、オープンソースであるSandcastleを使用しています。人々は主に XML ドキュメントからドキュメントを生成する厳密なアプリケーションと考えていますが、MAML で独自のコンテンツを提供することもできます。CHM と Web サイトの両方の展開をターゲットにすることができ、私たちのニーズを満たしています。私の理解では、お気に入りのマーク付けやトピックの評価などを提供できる追加のツールがいくつかありますが、まだ使用を開始していません。
これにより、内部および外部の両方のドキュメントが提供されます。私たちは Team Foundation Server も使用しているため、Sharepoint のチーム プロジェクトで組み込みの Wiki を使用していますが、それはプロジェクトの共同作業により適しています。
編集: 壊れたリンクを修正し、Sandcastle と組み合わせて使用するツールが他にもあることに言及したいと思います。Sandcastle Help File BuilderやGhostDocなどは一般的なツールです。1 人目は Sandcastle プロジェクトと MAML を編集し、2 人目はコードのコメント品質を改善しました。
私の現在の仕事では使い捨てのソフトウェアを大量生産しているため、ドキュメントはしばしば脇役になり、Word で作成されます。
しかし、私の最後の仕事では、ドキュメンテーション チームは、mad cap software の製品 "Flare"について絶え間なく怒鳴ったり絶賛したりしているようでした。1 つの形式で記述し、多くのメディアに公開できるため、マニュアルをオンライン ヘルプや Web サイトなどにすることもできます。
「マニュアル」については、Docbook。これは、技術文書用に設計された SGML の方言です。 http://www.docbook.org/。「簡単なマークアップ」の基準を満たしていない可能性がありますが、LaTex で適切な出力 (PDF に変換可能) と、独自の CSS スタイルシートを作成した場合に優れた HTML 出力を確実に生成します。バージョン管理で保持されるテキスト ファイル。すべてのプログラムは、コマンド ライン引数の解析と "--help" 出力をさまざまな形式 (通常、man ページ、および docbook) で組み合わせたライブラリも使用します。API リファレンスについては、もちろん doxygen です。
Dikiwikiをお試しください
Wordを使用しています。バージョン管理に入れられるので、履歴があります（すべてのプロジェクトにリンクされたドキュメントフォルダーがあります）。フォーマットはテンプレートを使用して制御できます。テンプレートはすべて設定済みであるため、レイアウト標準内で簡単に変更を加えることができます。ファイルはPDFにエクスポートできます。ユーザーと共有するための読み取り専用ドキュメントとして公開できます。
しばらくの間、DocBook を使用していましたが、より高度で必要な機能 (構文の強調表示、複数のファイルへの分割、多言語管理など) を拡張するのは非常に困難でした。その後、独自のシステムをゼロから作成し、オープンソースとしてリリースすることにしました: link text . プレーン テキスト ファイルと Markdown を構文言語として使用するため、必要なものはすべて揃っています。欠点は、現在、HTML 出力以外のものを生成する Markdown パーサーがおそらくないことです。今のところこれで十分ですが、近いうちに PDF サポートを実装することを考えています。
さらに、コミュニティベースのヘルプとして MediaWiki を維持しています。
私の会社では、ほとんどのドキュメントに MediaWiki と TikiWiki を使用しています。また、印刷/顧客への送信用に、MS Word および PDF 形式にコンパイルする担当者もいます。疫病のように TikiWiki を避けることをお勧めします。MediaWiki は非常に使いやすく、誰もがその使い方を知っているという点で優れています。これは事実上の標準の wiki であり、当然のことながら私見です。
私たちはDocToHelpで大きな成功を収めました。Microsoft Word ベースのドキュメントやその他のフォームとうまく連携し、Visual Studio との優れた統合機能も備えています。
コア ドキュメント ベースを DocToHelp にインポートすると、WinHelp、HTML ヘルプ、Java ヘルプ、または洗練された検索可能なネット ヘルプなど、多数のエクスポート形式のいずれかを選択できます。
コードについては、Doxigen を使用しています。私は Linux 版の方が好みですが、Windows 版ではいくつかの機能に問題がありました