質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.47%
ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

Q&A

解決済

2回答

424閲覧

アプリケーションを開発する上で作るべきドキュメントや書類

yamamotoyama

総合スコア25

ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

0グッド

1クリップ

投稿2019/09/13 09:40

私は趣味でアプリを作っていますが(言語はJavaです)例えば企業などがアプリ開発をするにあたってどの程度の量のドキュメントを作成するのが一般的なのでしょうか?

ちなみに私は以下のようなドキュメントをプロジェクトごとに作成してそのフォルダに入れていますが、後々メンテナンスや修正などをする上でこれで十分だと言えるでしょうか。
1.UMLのユースケース図 --全体像と全機能を把握するために使う。
2.各々のユースケースにおけるコミュニケーション図(UML) --各々のユースケースにおけるオブジェクトの具体的な動きを記録しておき、修正する際の手がかりとして使用。
3.全てのクラスのJavadoc --個々のクラスのソースコードから作った仕様書。あまり使用してません。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

「企業」と一言に言っても納品物に関する要件、ドキュメントにかけられる予算、ドキュメント作成及び利用する人のスキルと用途に依る としか言えません。

誰も使わないが納品しないと行けないので無駄に詳細なドキュメントがあったり、必要とされてるのにドキュメントが一切無かったりとか、本当にケースバイケースです。

後々メンテナンスや修正などをする上でこれで十分だと言えるでしょうか。

1年前くらいに作ったドキュメントを読んでみて十分と言えるなら「あなたがメンテナンスするには十分である」とは言えると思います。
他の人にとって十分かは対象を想定しないと判断できません。

投稿2019/09/13 10:17

tanat

総合スコア18713

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

ベストアンサー

私は趣味でアプリを作っていますが(言語はJavaです)例えば企業などがアプリ開発をするにあたってどの程度の量のドキュメントを作成するのが一般的なのでしょうか?

受託開発と自社開発でかなり違います。

受託開発の場合、納品物にドキュメントが含まれていることが多いので、それなりにきっちりドキュメントを作成します。

それに対して、自社開発の場合は、納品する必要がないので、最低限のドキュメントしか作成しません。


ちなみに私は以下のようなドキュメントをプロジェクトごとに作成してそのフォルダに入れていますが、後々メンテナンスや修正などをする上でこれで十分だと言えるでしょうか。
1.UMLのユースケース図 --全体像と全機能を把握するために使う。
2.各々のユースケースにおけるコミュニケーション図(UML) --各々のユースケースにおけるオブジェクトの具体的な動きを記録しておき、修正する際の手がかりとして使用。
3.全てのクラスのJavadoc --個々のクラスのソースコードから作った仕様書。あまり使用してません。

開発チームに新しいメンバーが加わったとして、「その人に説明するのに十分な資料となっているかどうか」で判断されると良いかと思います。

投稿2019/09/13 23:51

nskydiving

総合スコア6500

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.47%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問