タグ付けされた質問 「documentation」

私が書いたソフトウェアを詳細に文書化しようとしています。SASは高レベルであり、APIをカバーしていません。オンラインでSDSの例をいくつか見つけましたが、形式に傾向は見られません。 ソフトウェア設計仕様を作成するための一般的なガイドラインがあるかどうか、または最良のアプローチは何ですか？

8 documentation  api  uml  design 

現在、JavaScriptのセット実装に取り​​組んでいます。これは、JavaまたはC＃から知られているジェネリックをシミュレートする必要があります。その可変バージョン（設定値の追加/削除が可能）と不変バージョンが必要です。 私のコンストラクターの署名は次のようになります。 new GenericSet( 'number', [ 10, 20, 30 ] ); 、 // mutable set of mixed values (allows to add further values via "add") new MutableGenericSet( '*', [ 'foo', 42, {}, /./ ] ); または // DataValues.prototype.equals will be used by the set for determining equality. new GenericSet( { …

8 javascript  documentation 

インラインJavaドキュメントに代わる優れた方法は何でしょうか。つまり、Javaソースファイルに何らかの方法でマップされた個別のドキュメントファイルを持つことができますか？ 私はコードに散らばっている巨大なコメントセクションが好きではありません。

8 java  documentation  javadocs 

私は現在プロジェクトに取り組んでいます。そこでは、クラウドコンピューティングを使用する2つの特定のITシステムの要件を分析して、クラウドAPIを取得する必要があります。言い換えれば、私はこれらのシステムがクラウドAPIに対してどのような要件を持っているかを分析し、彼らが現在の目標を達成しながら、それを切り替えることができるようにする必要があります。 プロジェクトAの非公式な要件の例を挙げましょう。 APIを介してクラウドで仮想マシンを起動する場合、rootユーザーのメモリサイズ、CPUタイプ、オペレーティングシステム、SSHキーを指定できる必要があります。 仮想マシンごとに1時間あたりのインバウンドおよびアウトバウンドネットワークトラフィックを監視できる必要があります。 APIは、仮想マシンへのパブリックIPの割り当てとパブリックIPの取得をサポートする必要があります。 ... プロジェクトの後の段階で、クラウドAPIを標準化するいくつかのクラウドコンピューティング標準を分析して、現在の標準の潜在的な欠点がどこにあるかを見つけます。特定の標準はリソースの使用状況の監視をサポートしていないため、現在は使用できないという結果がおそらくあります。 現在、体系的に自分の要件を書き留めて分類する方法を模索しています。私が現在それらを書き留めている方法（上記の3つの点のように）はあまりにも非公式です。 私はいくつかの要件エンニーリングとソフトウェアアーキテクチャの本を読みましたが、それらはすべて詳細と実装に集中しすぎています。私は本当にAPI /インターフェースを介して提供される機能にのみ関心があり、UML図などは私にとって正しい選択だとは思いません。現在収集した要件はユーザーストーリーとして説明できると思いますが、高度な要件分析にはこれで十分ですか？たぶん私は「一段深く」行かなければならない...

8 documentation  api 

Djangoは初めてです。公式トピックガイドhttps://docs.djangoproject.com/en/1.3/は、学ぶのに最適な場所です。しかし今は、オブジェクトが持つメソッド、オブジェクトがとる引数、オブジェクトが返すものなどを確認するためのクイックリファレンスが必要な場所にいます。PythonドキュメントやJavaドキュメントのようなものです。チュートリアルよりも参照の方が多い。公式ドキュメントはチュートリアルスタイルであり、必ずしもすべてのメソッドへの参照があるとは限りません。 ここで何か不足していますか？誰にとってもDjangoの公式ドキュメントで十分ですか？

8 django  documentation 

休業。この質問には、より焦点を当てる必要があります。現在、回答を受け付けていません。 この質問を改善してみませんか？質問を更新して、この投稿を編集するだけで1つの問題に焦点を当てます。 2年前休業。 私は、オフショアリソースが私たちのプロジェクトに移行するときに、オフショアリソースの「開発アプローチ」ドキュメントを共同制作している最中です。 私たちの会社が使用した最新の（類似した）ドキュメントは80ページを超えており、これにはコーディング標準/規約のドキュメントは含まれていません。 私の懸念は、このドキュメントが消費可能ではないために失敗することです。 開発アプローチ文書には何を含めるべきですか？このトピックに関して適切なガイドラインはありますか？ 編集：開発アプローチ文書には、ソフトウェアの設計、構築、およびテスト中にソフトウェア開発者が使用するプラクティスとテクニックの詳細を記載する必要があります。

8 development-process  documentation  team 

アジャイルテストチームに優れたテスト計画テンプレートを推奨できますか？Webでテストするためのテンプレートがあり、検索エンジンで見つかったものをすでに確認しましたが、軽量で、熟練したテスターがすでに試し、うまく機能することがわかっているものを実際に使用できます。私が見た多くのテンプレートは、テスト文書を書くことはそれらのテスターがしている仕事の3分の1であると期待されていると感じさせますが、私のチームは本当に少ないドキュメントとより実際のテストを使うことを好みます。ドキュメントにはウィキを使用しているので、生きたドキュメントに適したアプローチが素晴らしいでしょう。 テスト計画にもっと構造化されたアプローチを使用することで、テスト計画の有用性が高まると同時に、計画の形式や構造ではなく、テストについて考えることを可能にすることで、テストを作成する労力が減ることを願っています。私の職場にはまだ手元に何かがないので、私が始めたものは何でも会社に採用されるかもしれません。

8 testing  documentation 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 5年前休業。 私のチームは最近、一部の作業をオフロードする必要があった開発者の数が非常に少なくなったチームからプロジェクトを継承しました。私たちが継承したプロジェクトの1つは、ネストされたコードが散らばったプロジェクトとひどい例外処理です（例外は実際にはgotoステートメントとして処理され、通常のプログラムフローの一部として使用されていました）。 全体として、それは誰かが数年間咳をしてきた毛深いコードボールでした。 現在、私たちはかなり長い間いくつかのチームガイドラインを用意していますが、オブジェクトの構造、コーディングスタイル、およびそうでないものに関するすべての考慮事項があります。ただし、例外処理については取り上げていません。 だから、例外処理に関してあなたのチームにガイドラインがあるかどうか、そしてもしそうならどのようにそれらを実施するのか？

8 documentation  team  exception-handling  coding-style 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 4年前休業。 関数点を測定することはどれほど役に立ちますか？ 私は新しい仕事で関数ポイントを使用します。機能のポイントは聞いたことがありますが、トレーニングや経験はありませんが、簡単に説明できないことにはあまり自信がありません。

8 project-management  documentation 

閉まっている。この質問はトピックから外れています。現在、回答を受け付けていません。 この質問を改善してみませんか？ 質問を更新して、ソフトウェアエンジニアリングスタック交換のトピックになるようにします。 4年前休業。 私は最近、実装計画文書を作成するタスクを与えられました。見れるものの例を尋ねると、すでにベースとして利用しているプロジェクトプランを見るように言われました。私はまだ何を作成する必要があるかについて少し混乱しています。 誰かが私にそこの良い例や、これが何であるか、そしてもっと重要なことには何が含まれるべきかについての詳細を説明する何かを私に指摘できますか？

8 project-management  documentation 

私の同僚は、アジャイル開発に関するセミナーにかつて、ユニットテストを技術文書として使用することが可能だと聞いていました。クラスの使用方法の例として単体テストを使用するようなもの。 Googleのクイック検索でTDDとドキュメントが提供されました。これにより、それが可能であることが証明されます。しかし、コードを見ると、明らかにそのような方法で単体テストを実装できていないことがわかります。 私の意見では、ユニットテストは、モックおよび偽のクラスと関数の助けがあっても、最小限のユニットとしてコードをテストするためにあります。 したがって、質問は次のとおりです。 クラス（またはクラスのセット）の使用方法を示すのは、機能テストのタスクではありませんか？ 単体テストを技術文書として使用できる場合、そのような単体テストの実装方法に関するガイドラインはありますか？

8 agile  unit-testing  documentation  tdd 

私はC＃でいくつかの定量ライブラリを開発しました。XMLDocコメントに関連する古典的な情報（メソッドシグネチャの基本情報を含む）だけでなく、メソッド内で使用されている数式も理解することが重要です。 したがって、コードに拡張ドキュメントを含めることができるようにしたいと考えています。これには、たとえば、ラテックスの数式、グラフなどを含めることができます。 そのような情報をAPIドキュメントに含める必要があると思いますか？ または、例として開発ブログに含める必要がありますか？ この種の目的で通常使用される一般的なツールはありますか？

8 documentation  documentation-generation 

私は、累積的なエラーの影響と、絶対計算を使用することがなぜ重要であるのかを、技術的でない用語で説明する必要があるレポートに取り組んでいます。 dictionary.comからの「累積エラー」の定義： 一連の測定または計算中に次第にまたは重要度が徐々に増加するエラー。観察中に増大するエラー 理想的には、実際の例を挙げて、具体的なことを知らなくてもその概念を理解できるようにすることができます。 私が最初に考えたのは、かなり有名な「チャイニーズウィスパーズ」ですが、「現実の世界」として正確に分類することはしません。誰かがより良い例を知っていますか？

8 documentation  terminology  management