私は、このような要件を満足するヘルプ/ドキュメント生成ツールを探しています:ヘルプ作成ツール
- それは、C#コンパイラまたは(より良い)によって生成さXMLDOCのコメントをサポートする必要があります
- MS Word文書のインポートをサポートする必要があります。
- 概念的なドキュメントからソースコードから生成された参照ドキュメントへのリンクの作成をサポートする必要があります。
- それはMS Wordの
詳細に概念的なドキュメントのオーサリングをサポートしている場合、それはいいだろう。 私のプロジェクトは.NET用のフレームワーク/ライブラリです。これには、50以上のC#プロジェクトを持つ複数のVSソリューションがあります。まず、自分のプロジェクトのソースコードからヘルプを生成したい(chm & help2 & help3)。そのドキュメントを「リファレンスドキュメント」と呼ぶことにします。サンドキャッスル(特にSCFBを使って)はこれをとてもうまくやり遂げることができます。 (私はそれは非常に一般的な状況だと思います)私はフレームワーク/ライブラリのためのいくつかの追加のドキュメントがあります。そのドキュメントはMS Wordファイル(5-10ファイル)にあります。そのドキュメンテーションを「概念的な文書」と呼ぶことにします。 私は概念的なドキュメントとリファレンスドキュメント(MSDNのような)を使って、実践的なヘルプシステムを作りたいと思っています。 そして、私は、ヘルプの概念的部分には、フレームワーク/ライブラリの各.NETタイプ名のヘルプの参照部分を参照するリンク(URL)が含まれています。 (明らかに、ヘルプシステムは結局はHTMLだけです)。
問題は、これらのリンクを作成する方法です。 MS WordファイルはC#xmldocについて何も知らない。 SandcastleはWordファイルをサポートしていません。だから私はいくつかのヘルプオーサリングツール(HAT)を取らなければならない。 私は妥当な道具を見つけることができません。そして、私はどんな助けでも非常に感謝しています!
すべてのツールの不具合ブロックは、リンクの自動作成です。私はリンクを自動的に世代のduriningを作成する(ビルドサーバー上で行うことができます)したいと思います。なぜ自動的に?これは、型の名前を簡単に変更できるためです。 インスタンスの場合。私はいくつかのテキストを概念的な文書に持っています: "要求処理コンテキストにアクセスするためには、静的プロパティCurrentのXOperationContext型を使用してください"。ここで、XOperationContextは型名です。 XOperationContextクラスの仕様へのリンク(URL)となりました。 Word(おそらくいくつかのHATのプラグインがインストールされている)またはHATのエディタに「可能であればこの単語のリンクを作成する」のようなマークを付けたいと思います。世代の間、そのような名前のタイプ名がある場合、そのような単語はリンクになります。
私は、これらのツールについて知っている:(今使って)
DOC-O-Maticはサポートリンクの自動作成。本当に自動的に。 PascalCaseの各単語のリンクを作成しようとします。しかし、MS Wordはサポートしていません。 InnovasysとComponentOneのソフトウェアは、リンクの自動作成をサポートしていません。 InnovasysのソフトウェアはMS Wordをサポートしていません(私はこれについて100%は分かりません)。
私はInnovasysとComponentOneのフォーラムで尋ねました。今まで運がない。 私のようなInnovasysのソフトサポートシナリオ:別のツールで概念的な文書を作成する - HelpStudioと、別のツールでソースコードからヘルプを生成する - DocumentX。しかし、自動的にリンクを作成してMS Wordファイルをインポートする機能はありません。
だから、その共通の仕事のために期限を共有してください(私はそれが一般的でなければならないと確信しています)。
p.s.もし私が英語の文法の観点から私の考えを正しく説明できなかったら、もう一度試してみてください。
質問はまだありません – Shrike
私の現在のすべてのドキュメント(Wordファイル)をConfluence Wikiに移行することを検討しています。それはそれ自体の問題ではない。 サンドキャッスルの出力と統合するのがずっと難しくなります。 – Shrike
Word文書をインポートするとはどういう意味ですか? Word文書をインポートして書式を保持する一般的な方法はないようです。 –