documentation

2熱

5答えて

visoについてのいくつかの悪い報告を読んで、DBを文書化しています...私は単にDBを文書化し、すべての鍵と関係を表示したいと思います... visioは正しい方法ですか？ ...そのかなり小さなプロジェクトとVisioが値札を運ぶん... 私はVS 2008使用していますし、これは統合データベースダイアグラムを持っていますが、私は何を誰にその強力なそのどれ見解を考えていません使用すると、な

3熱

1答えて

PHPDocの冗長性はそれ以上の価値がありますか？

今日初めてPHPDocを使ってみましたが、すぐに問題が発生しました。変数宣言の1行ごとに、少なくとも5行のコメントがありました。例： /** * Holds path the remote server * @name ... * @global ... */ $myvar = ... もちろん、報酬は素晴らしいですが、これは10行の設定ファイルを60行のファイルに変換します。私は

0熱

7答えて

既存のコードを文書化しています

私はちょうどHeroicショップに加わりました。コードはきれいで質が高いようですが、話すべきドキュメントはありません。（コードは小さなグループによって作成され、管理されていました）。したがって、新しいエンジニアは設計を決定するためにソースからリエンジニアリングする必要があります。プロジェクトが小規模なチームから大規模なチームに移行しているので、次の雇用者がそれらをより早く学ぶことができるように、

1熱

1答えて

Webサービスのドキュメント標準/構造/スタイル

Webサービスの高水準ドキュメントのガイドラインをお勧めしますか？これは、特定のWebサービスに関する知識のない人が、その理由、そのロードマップとその使用例を基本的に理解できるようにするドキュメントです。このようなドキュメントは、A4/Letter用紙の2辺に収まるようにして、10分以内に読むことをお勧めします。これは、開発者がインタフェースを使用するために使用する低レベルのAPIドキュメン

2熱

3答えて

テクニカルデザインドキュメント

実際のコーディングを開始するのに十分なレベルの技術デザインドキュメントはありますか？

48熱

6答えて

Objective-Cのドキュメントジェネレータ？

Objective-Cの一般的に受け入れられているドキュメントジェネレータはありますか（RubyのRDocに似ています）？私はDoxygenとObjcDocを見たことがあり、どれが最も広く使われているのだろうと思っています。

22熱

5答えて

WCFインターフェイスを文書化する最も良い方法は？

私はWCFを使用しており、社内のアプリケーションのために他の会社に提供するインタフェースとサービスを文書化したいと考えています。これらのインタフェースを文書化する最良の方法は何ですか？私は、コードとインラインでドキュメントを持っていることを好むだろうし、HTMLを出力するために何かを持っているが、それを行うための推奨された方法があるか分からない。

0熱

1答えて

Flash/Flex/AIRのヘルプシステム

私はFlex/AIRでデスクトップアプリケーションを構築しています。私のTODOリストの現在のアイテムの1つは、ヘルプシステムを開発することです。 GUI全体にはほとんど（？）ボタンがありません。ユーザーがこれらのボタンの1つをクリックすると、HelpPanelが表示され、ドキュメントの関連情報が表示されます。十分に単純です。しかし、私は実際には、通常、デスクトップアプリケーションに展開するも

1熱

5答えて

XSDを文書化する手間が省けますか？

最近、XMLを介してクライアントにデータ抽出を提供し始めました。このXMLの構造を定義するスキーマ（XSD）があります。私は要素と属性のドキュメントをスキーマ自体に含めたいと思っています。私が見つけている唯一のことは、非常に面倒な "注釈"と "ドキュメンテーション"タグです。だから、このよう読まするシンプルで簡単な何かを取る： <xs:element name="TransactionType

43熱

3答えて

誰かがSphinxを使ってC++プロジェクトを文書化していますか？

Sphinxは、Python用の新しいドキュメントツールです。とても素敵ですね。私が思っているのは：これはC++プロジェクトの文書化にどれくらい適していますか？既存のドキュメント（doxygenなど）をSphinx形式に変換するツールはありますか？ Sphinxを使用するC++プロジェクトのオンライン/ダウンロード可能なサンプルがありますか？スフィンクスを使ったことがある人のヒント