WEBサイトの制作を外注しまして、以降自社で、エンジニアさんを呼んで、改修など手を加えたい場合、どのような書類があれば、エンジニアさんが内容把握しやすいでしょうか?
もちろん、WEBサイトの大きさや、エンジニアさんの経験などにもよると思いますが、
簡単に説明しますと
●PHPで開発している。
●オブジェクト指向である
●排他処理されているプログラムである
●SSL使用、決済機能付きである
●DBのテーブル内容(カラム)など、複雑に作成されている
設計書とか仕様書というようなものがあればと思うのですが、
制作会社によっても仕様書などの書き方って違うと思うんですよね?
ものすごくわかりやすいものなら良いのですが、そういう訳でもないかもしれない…
ちなみに、私は経験はPHPとmysql、オブジェクト指向の勉強程度で、画面遷移や仕様書などを見て改修した経験がないので、本当に想像で申し訳ないのですが
結構大きなシステムの紐解きを、エンジニアさんが、無理なく全体象を把握できるようなものがあればいいと思うのです。
そこで、仕様書でも良いけれども、以下のような書類で解決できないものか?
と挙げてみたのですが…
●各ファイル説明書
WEBサイトが動作するために使用しているファイルの名前と簡単な説明
(××に関するオブジェクトを記載したファイル、××の設定ファイルなど)
●オブジェクト説明書
WEBサイトが動作するために使用しているオブジェクトの名前と説明
●DBの設計書
WEBサイトが動作するために使用している各テーブル、各カラムの名前と詳細説明
●各ページからの画面遷移書
リンク詳細、ボタンクリックにより動作するものに関しては番号付加
(キャプチャーするなどで、自社でもできる)
●機能説明書
画面遷移書に記載された番号付きボタンに関しての機能説明
●サーバー設定などの説明書
以上のようなものがある場合、これはあまり必要ないとか、これは必要とか
また、もし、エンジニアとしては、こういうのがあると改修しやすい、仕様書に説明がある方が使いやすいなど、ありましたら、ご意見を頂きたいのです。
エンジニアさんとして活躍している方でも、こういったWEBサイトを経験した事がある方まで、
大変お手数お掛けしますが、エンジニアさんの立場のご意見を、お願いします。
できましたら、ご経験年数、どんな開発をされているかなど簡単にお書き添え頂けますと幸いです。
どうぞよろしくお願い致します。
No.1ベストアンサー
- 回答日時:
具体的ではなく抽象的な言い方ですが、
「やりたいこと(やりたかったこと)」「やれること」「やったこと」がまとまっていると良いですね。
ドキュメントがなかったり、散逸していたり、はよくあることです。
そうなるとソースを読んでいくことになるのですが、
「やりたいこと」「やれること」がまとまっていると「やったこと」であるソースが読みやすくなります。
仕様書、設計書などの名の付いたドキュメントがあっても、
「やりたいこと」「やれること」「やったこと」が理解できなければ意味がありません。
あと、内容が分からないので何とも言えませんが、業務と絡めたドキュメントも必要でしょう。
プレイヤーがいて処理があって金・物・情報がどのように動いて、、、
といったフローの中でシステムがどの部分を占めるのか、はあった方が良いでしょう。
ドキュメント作成の参考にしてみてください。
お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!
関連するカテゴリからQ&Aを探す
おすすめ情報
- ・漫画をレンタルでお得に読める!
- ・街中で見かけて「グッときた人」の思い出
- ・「一気に最後まで読んだ」本、教えて下さい!
- ・幼稚園時代「何組」でしたか?
- ・激凹みから立ち直る方法
- ・1つだけ過去を変えられるとしたら?
- ・【あるあるbot連動企画】あるあるbotに投稿したけど採用されなかったあるある募集
- ・【あるあるbot連動企画】フォロワー20万人のアカウントであなたのあるあるを披露してみませんか?
- ・映画のエンドロール観る派?観ない派?
- ・海外旅行から帰ってきたら、まず何を食べる?
- ・誕生日にもらった意外なもの
- ・天使と悪魔選手権
- ・ちょっと先の未来クイズ第2問
- ・【大喜利】【投稿~9/7】 ロボットの住む世界で流行ってる罰ゲームとは?
- ・推しミネラルウォーターはありますか?
- ・都道府県穴埋めゲーム
- ・この人頭いいなと思ったエピソード
- ・準・究極の選択
- ・ゆるやかでぃべーと タイムマシンを破壊すべきか。
- ・歩いた自慢大会
- ・許せない心理テスト
- ・字面がカッコいい英単語
- ・これ何て呼びますか Part2
- ・人生で一番思い出に残ってる靴
- ・ゆるやかでぃべーと すべての高校生はアルバイトをするべきだ。
- ・初めて自分の家と他人の家が違う、と意識した時
- ・単二電池
- ・チョコミントアイス
デイリーランキングこのカテゴリの人気デイリーQ&Aランキング
-
一流メーカーでもエンジニアや...
-
セキュリティエンジニアについて
-
何でIT系のエンジニアってカッ...
-
サービスエンジニアの転職方法...
-
肩書きAE
-
システムエンジニア,ソフトウ...
-
unityエンジニアの就活作品につ...
-
組込みエンジニアについて
-
フロントエンジニアとシステム...
-
クライアントに出すメールで、...
-
Yahoo知恵袋の回答が心無いもの...
-
LINEで、質問されたから答えた...
-
独身男性はどうやって性欲をお...
-
「ありますか」と聞く場合、Is...
-
27,8歳からプログラマ・シ...
-
成人知能検査の結果を教えてく...
-
「データ」のスペルはdataとdat...
-
『技術』の反対語って何ですか
-
何度も同じ事を言わせる人は何...
-
看護学生です。 明日から実習が...
マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング
-
ITエンジニアに向いてる女性の...
-
一流メーカーでもエンジニアや...
-
ITエンジニアは手に職ついた仕...
-
システムエンジニア,ソフトウ...
-
エンジニア目線で、富士通、楽...
-
組込みエンジニアについて
-
エンジニアってキモいという印...
-
フィルカッフェルについて教え...
-
フロントエンドエンジニアが評...
-
データサイエンス職で、メガベ...
-
エンジニアなんて、使い捨てで...
-
FAエンジニアとは何をするエン...
-
ギター職人になるには
-
理解不足の状況でシステムの本...
-
基幹システムの改修費用の交渉...
-
肩書きAE
-
エンジニアをされている方に質...
-
プログラミングスクールでエン...
-
大手テクノロジー企業で働いて...
-
「エンジニア」と聞いて思い浮...
おすすめ情報