問題タブ [documentation]

私はそれがいくつかの場所を使用しているのを見ました：

• http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
• http://developer.yahoo.com/flash/astra-flash/classreference/

これは単なる偶然ですか、それとも私がつかむことができる場所ですか？私が取り組んでいる新しいプロジェクトにそれを使用したいと思います。

ありがとう！

次のシナリオで何を提案しますか。

複雑なシステムを構築および設計するには、多数の開発者が必要です。この設計は、将来の開発者のために文書化する必要があり、設計上の決定に注意する必要があります。これらのレポートは、約 2 か月ごとに作成する必要があります。私の質問は、このプロジェクトをどのように文書化するかです。

2つの可能性が見えます。各開発者は、設計と統合に役立ったことについて書き、1 人がこれらのドキュメントを 1 つにまとめます。すべてを組み立てる任務を負っている担当者は、すべての部品を調整する時間があまりないため、最終的なドキュメントはおそらく一貫性がなかったり、冗長になったりすることがあります。

各開発者からのドキュメント パーツが締め切りの数日前に届くとします。締め切りの数日前まで読むものがないため、共同システム (つまり wiki) は適切に機能しません。

それとも、チームの残りのメンバーが実際のシステム開発に取り組んでいる間に、少数の人 (2 ～ 3 人) がドキュメントの作成を担当する必要がありますか? 開発者は、設計上の選択と結論をテクニカル ライターに伝える方法が必要です。これを効率的に行うにはどうすればよいでしょうか。

(注: これはHow do you document your database structure?に近いと思いますが、同一ではないと思います。)

私は、文字通り数百のテーブルとビューを持つデータベースのある場所で仕事を始めました。すべて母音がほとんどなく、ドキュメントもありません。また、データベース スキーマへの不当な変更も許可されていません。また、自分のマシンのテスト用のデータベース (吹き飛ばされ、定期的に再作成される) 以外のデータベースに触れることもできないため、誰の助けにもならないようなコメントを追加することはできません。

"Toad" を使用して ER 図を作成しようとしましたが、48 時間実行したままにしておくと、何も表示されず、コンピューターを元に戻す必要がありました。私は他の最近採用した人たちと話していて、特定のテーブルやその列が何を意味するのか分からなくなったときはいつでも、開発者 wiki でそれを更新するべきだと提案しました。

では、これを行う良い方法は何ですか? テーブル/ビューとその列をリストして、それらを埋めていくだけですか? 私が持っている基本的なツールは、Toad、Oracle の「SQL Developer」、MS Office、および Visio です。

##このコメントを使用してこれを再開しようとしています

ユーザーマニュアルを作成するための推奨プログラムを教えてください。マークアップ言語 (LaTeX や DocBook など) ではなく、Scribus のようなインタラクティブな言語です。マニュアルを更新するのは私だけではないので、ソフトウェアは初心者が簡単に習得できるものである必要がありますが、それでもいくつかの高度な機能 (外部ソース/テーブルからのテキストへのリンク、マスターページ/テーマの処理など) を備えている必要があります。 .

よろしく、オスカー

怒りでJavaを使って久しぶりですので、ばかげたらご容赦ください。

JAXBを使用して（Jetty Serverからの）着信XML文字列を逆シリアル化するJavaプロジェクトを開始しました。プロジェクトは、この状況でJAXBのみを使用しています。

JAXBの代替手段は何ですか？
これらの代替案に対するJAXBの長所/短所は何ですか

私はいくつかのグーグルを行い、多くの参考資料を見つけましたが、JAXBの質問の行き先となる決定的な情報源はありますか、それとも人々は人々が何をしているのかを見て、そこから解釈するだけですか。

ありがとう。

Doxygen を使用して HTML ドキュメントを単一の非常に長いファイルとして作成するにはどうすればよいですか? RTF出力のようなものが欲しいが、HTMLとして。

理由: API を単一の印刷可能なドキュメントとして公開する必要があります。Word に読み込めるもの、PDF に変換できるものなど。

アロハ

次のような xs: ドキュメント タグが付いた素敵な wsdl を受け取りました。

///<summary>これからタグを生成する方法はありますか? 私はビジュアルスタジオ2008を使用しています

アンプル プロジェクトは、javadoc のようなタグを docstring で使用します。

たとえば、pool.pyの 86 行目から:

これらのタグとは何ですか、どのツールがそれを使用していますか。

GhostDoc テンプレート テキストのドイツ語版を作成した人はいますか?

「プラグイン」を使って拡張できるアプリを開発しています。プラグインは非常に基本的なもので、開発者はアプリケーションに新しい「アクション」を追加できます。

開発者が必要なことを実行できるようにするには、どのようなドキュメントや情報を提供する必要がありますか?

アプリケーション/プラグインがどのように機能するかの短い例と一般的な概要を考えていましたか?