問題タブ [documentation-generation]

ドキュメントテンプレートシステムを探しているか、作成する予定です。次の機能をサポートする必要があります。

• PDFとHTMLで出力を作成する
• 大規模で複雑な（LaTeX）数式のサポート
• ドキュメント間の参照
• 参考文献
• テンプレートはPythonスクリプトで埋められます

さまざまなTeXからHTMLへのコンバーターでLaTeXを試しましたが、結果に満足できません。私はしばらくDocBookを使用していますが、DocBookの編集は簡単ではなく、数式のサポートはまだ十分ではないと思います。

主な問題は、LaTeX構文またはDocBookを知らないこのシステムのユーザーがいることです。私は、これらのユーザーがWiki構文（PythonによってLaTeXに変換）で編集の可能性を提供するための代替案について考えました。

要約すると、少なくともLaTeXとWikiの入力からHTMLとPDFの出力が必要です。DocBookは中間フォーマットとして使用できます。

誰かが同様の問題を抱えているか、どのツールとどのファイル形式を使用すべきかについてアドバイスをくれますか？

XPS ドキュメントを作成するために Web サービスを使用する Silverlight アプリケーションがあります。ドキュメント テンプレートは、WCF クラス ライブラリの XAML コントロールとして作成されます。

実際のデータをドキュメント テンプレートにバインドするために、コントロールの DataContext プロパティを設定します。問題は、XPS を見ると、画像 (画像コントロールのソースを画像の URL を表す文字列プロパティにバインド) が読み込まれていないかのように表示されないことです。どうすればこの問題を解決できますか? ありがとう！

既存のOracleデータベースからER図（または同様のもの）を生成するためのツール（Windowsプラットフォーム）を探しています。
無料で使用できる、または低コストの優れたツールはありますか？

教えてください、Visual Studio で標準の XML Doc から適切なドキュメントを生成することは可能ですか? xml からユーザーフレンドリーな外観へのエクスポートで?

重複の可能性:
PHPDoc より優れたものはありますか?

PHP 5.3 をサポートするドキュメンテーション ソリューションが利用可能かどうか疑問に思っていました。phpDocumentor には 2 つの問題があります。まず、5.3 のサポートがありません。次に、コードベースで使用すると大量のメモリが必要になります。

誰かphpDocumentorの実行可能な代替案を提案できますか?

ありがとうございました！

OK、php コードからドキュメントを生成するための PhpDocumentor があることは知っています。長い間更新されていないようです (しかし、彼らはほとんどの機能が完成していると考えているかもしれません)。

これは、他のプログラマーのために文書化するのには適しているかもしれませんが、Web サービスの外部「API」を文書化するのにはあまり適していないようです。IE で MVC 構造化プロジェクトを作成した場合、PhpDocumentor はそのプロジェクトの他の開発者向けにすべてのモデルと内部ライブラリなどを文書化するのに最適ですが、それが提供する Web サービスを文書化するにはどうすればよいですか?

次のようなタグを使用して、コントローラーのメソッドを文書化できる場所を考えています。

生成されたドキュメントでは、POST 要求を実行する必要があることが示されます。JSON データが返され、それにアクセスするための URL はhttp://whatever.com/device/addです。明らかに、これらのサービス呼び出しのベース URL を定義するドキュメント用のグローバル構成ファイルがあります。

この時点で、phpdoc ブロックでリフレクションを使用して (または追加ライブラリで注釈を使用して) 自分で何かを実装し、アプリケーションで直接ドキュメントに動的にアクセスできるようにしようと考えています。

Perl には Perl Docs ジェネレーターがありますか? Java Docs や PHP Documenter のようなものですか?

私は、部門のドキュメント リポジトリのアーキテクチャを再設計する任務を負っています。現在、複数の SharePoint サーバーに何百ものドキュメントがあり、それらを 1 つのリポジトリに統合して、ユーザーがドキュメントを簡単に見つけて更新できるようにしたいと考えています。

ベスト プラクティス、ケース スタディ、ヒントなど、参考になるリソースを教えてください。

どんな助けでも大歓迎です。ありがとう。

私は C プロジェクトに取り組んでおり、さまざまな作成者とさまざまなドキュメンテーション スタイルを見てきました。

私はdoxygenやその他のドキュメント生成ツールの大ファンで、このプロジェクトを移行してこれらのシステムの 1 つを使用したいと考えています。

ソースコードのコメントをスキャンして、「説明」、「作成者」、「ファイル名」などのキーワードやその他の種類のコンテキストをスキャンして、コメントを標準形式にインテリジェントに変換できるツールを知っている人はいますか? そうでない場合は、クレイジーなスクリプトを作成するか、手動で変換できると思います。

ありがとう

私は自分の会社がドキュメンテーション（特にプログラミングドキュメンテーション）をどのように行うかに取り組んでいます。異なるWord文書のセクションを同期できるようにしたいのですが、一方の文書のセクションが変更された場合、その変更はもう一方の文書に反映され、その逆も同様です。Wordでこれを行う方法はありますか？そうでない場合は、これが得意なワードプロセッシングプログラムはありますか？