ホームページ >

全体のデザインと詳細なドキュメントの作成方法

2014/12/26 15:34:00 28

ドキュメント、デザイン、モジュールドキュメントが必要です。

総設定と詳細設定の両方に含まれるべき部分:

(1)需要:一般的に製品の言語で説明していますが、これは製品をコピーすることができます。

文書が必要です

におけるstory list部分。

(2)名詞解釈(オプション):関連分野でない学生は文書を見て事前に知っておく必要があるいくつかの概念的性質のものを見なければなりません。

(3)

設計目標

:機能目標と性能目標に分けられ、機能目標は一般的に製品のニーズに関する技術記述であり、性能目標は製品から与えられたデータに基づいて性能を評価する。

一般的に、新しいサービスは性能目標が必要です。性能目標は設計案に影響を与えるかもしれません。

全部含まれるべき部分を除いて、全体的なデザインは一般的に含まれています。

(1)システムアーキテクチャ:一般的には簡単なアーキテクチャ図があり、テキストでアーキテクチャを簡単に説明するために配置される。

(2)モジュール概要:アーキテクチャ図に多くのモジュールがある場合、各モジュールの機能を簡単に紹介する必要がある。

(3)設計と折衷:設計と折衷は全体設計の中で最も重要な部分である。

(4)潜在リスク(オプション)

全体設計を出力する時、多くの方案はまだ確定していないので、設計審査会議で確認する必要があります。

全体の設計の重点は「方案折衷」で、全体の設計審査が終わった後、すべての方案が確認されたはずです。各モジュールの詳細設計を出力する必要があります。

詳細設計のポイントは「詳細」です。

(1)全体設計の結論まとめ(オプション):全体設計で合意した結論には簡単な概要があり、詳細設定はこれらの結論の実現であることを説明する。

(2)インタラクションの流れ:簡潔なインタラクションは文字で説明でき、複雑なインタラクションの提案はフローチャート、インタラクション図または他の図形を使って説明することができる。

(3)データベース設計:これは総設計に置くべきですか?それとも詳細設定に置くべきですか?

(4)インターフェース形式:データベース+インターフェース+プロセスがあり、他の学生が詳細設定文書を入手すれば、ほぼ解決できます。

(5)その他の詳細:例えば数式など。

理論的に詳細設計を出力した後、誰がこの詳細設定文書を入手しても、このプロジェクトを完成させることができます。

実践共有:

一、大図

(1)大システムや複雑な流れは、そのフレームの構図やフローチャートが非常に大きく、常にA 4用紙やwordのページよりも大きいので、wordに直接図形を貼るのはよくないです。貼ってもよく見えません。図をwikiに置くと、ドキュメントに直接リンクすることを勧めます。

(2)visoまたは他の図形のソースファイルを必ず保存してください。そうでないと、今後変更したら描き直します。価格は予想できます。

二、設計と折衷

(1)設計と折衷は総設計の中で一番重要な内容で、総設計審査中、主にこれらの折衷の優劣を討論します。

(2)審査後、メールで結論を周知するだけでなく、全体の設営の中で更新し、最終的にどの方案を使用したのかを説明します。なぜこの方案を使用したのですか?自分の経験によって、他人のモジュール、プロジェクトを引き継いで、コードとドキュメントを入手して、設計案は私にとって完全に謎です。

(3)時には期限を決める或いはその他の原因のため、最適な設計方案を採用したとは限らなくて、この時は更に総括的な設定の中で方策決定の過程と原因を記録すべきです。

(4)最後に、設計折衷はとてもいい自己弁護の機会です。プロジェクトの進捗状況や歴史的な問題が残っているため、このような設計を取らざるを得なくなりました。

三、性能目標

性能目標は新

モジュールドキュメント

必要不可欠な一部であり、多くの項目が性能に大きな影響を与える場合、性能目標も書かなければなりません。性能には主に以下の部分が含まれています。

(1)日平均要求:一般的に製品人員からの評価;

(2)平均QPS:日平均要求は4 w秒で割ったもので、なぜ4 w秒なのか、24時間が86400秒になり、ユーザの活動時間を昼として計算すると、2を除いて4 w秒になる。

(3)ピークQPS:通常はQPSの2~4倍で計算できます。

インターネット会社では、製品の反復ブロックは、プロジェクトのサイクルが長いので、「ドキュメント」という言葉はほとんどないですが、実際には文書を作成して、システムとプロジェクトの将来のメンテナンスに非常に役立ちます。


  • 関連記事

电子文档安全解决方案

文書管理
|
2014/12/26 15:28:00
31

コンピュータが自動的にシャットダウンして、WORD文書が保存されていません。どうすればいいですか?

文書管理
|
2014/12/26 15:24:00
173

文書を書く過程は文書自体より重要です。

文書管理
|
2014/12/26 15:21:00
35

「紅旗」原則と「避風港」原則の適用は争議を引き起こします。

文書管理
|
2014/11/26 17:28:00
30

逐一审查文档版权成难题

文書管理
|
2014/11/26 17:26:00
14
次の文章を読みます

上海紡織集団の国際化発展の方向

上海紡織グループは最近アフリカのある国で「新型紡績産業園」プロジェクトを開始しました。子供の養子の話によると、アフリカの優勢な土地資源を利用して綿を栽培し、紡績品を生産し、10億アフリカの人々に服を提供する能力があるということです。同時に現地の特色を結び付けて、本当に紡織グループを“全世界の紡績”に作り上げます。