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

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

新規登録して質問してみよう
ただいま回答率
85.50%
WebRTC

WebRTC(Web Real-Time Communication)とは、プラグイン無しでウェブブラウザ間の音声通話・ビデオチャットなどリアルタイムコミュニケーションができるオープンフレームワークです。W3CがAPIレベルで、IETFがプロトコルレベルでそれぞれ標準化が進められています。

Q&A

解決済

4回答

659閲覧

ひとりで開発を進めており、社内向けの開発仕様書を簡単なテンプレートから作りたい

TarouKotani

総合スコア42

WebRTC

WebRTC(Web Real-Time Communication)とは、プラグイン無しでウェブブラウザ間の音声通話・ビデオチャットなどリアルタイムコミュニケーションができるオープンフレームワークです。W3CがAPIレベルで、IETFがプロトコルレベルでそれぞれ標準化が進められています。

0グッド

2クリップ

投稿2017/08/14 01:37

社内での開発第1号としてひとりでアプリを開発します。
社内向けに開発仕様書を作成するのですが、ネットのテンプレートを見ると具体的な中身を書いておらず、社内での過去の仕様書の様式に従って書いているのではないかと想像しています。

これからもひとり、またはアジャイルでの開発を行うので、その上で開発内容を社内向けに説明するのに必要な事項と進捗管理をするのに適合しているテンプレートがありましたら教えていただきたいです。

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

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

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

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

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

guest

回答4

0

ほぼ書きなぐりで読みづらい点、お詫びします。

説明資料と仕様書は分けて考えた方がよいと思います。
というのも、仕様書は漏れを防ぐため網羅的に書き、説明資料は全体像の把握のため省略的に書く傾向が強いからです。

説明資料は使い回し手も構いませんが、都度用意したほうがよいと思います。相手によってポイントが違います。
仕様書は、ソースコードを補完するものです。つまり、ソースコードのコメントと同様です。最新であることが大事です。
(そして、少ない方が望ましい。)

開発時の仕様書はコードがない時点では詳細なものが存在しても構いませんが、ソースコードと重複する資料はメンテ対象外にした方が管理負荷が減ります。ソースコードに書いて有ることはコメントで書かないのと同様の理由です。

自己防衛のため、詳細な仕様書をユーザーと合意しなければいけない組織もあると思いますが、私の経験では、社内の場合は、約束より業務が優先されるのは当然で誰の責任でも実装しなくて良いわけではありません。(その上で何かあったときに責任追及されないためにやるべきことが山のようになあるきがしますがうまく説明する自信がありません。)

とはいえ、改めて確認する手段として文書にすることはもちろん大切です。あまり、形式張ってわかり辛くならないようにあるべき姿を説明してください。合意したという事実より誤解を減らすことに注力したほうが生産的です。

以上のことを踏まえて、その時々で日々見直しをかけて下さい。その時々でベストな状態というのは変わって行きます。
テンプレートは作っても構いませんが、これも日々見直しをかける必要があります。汎用的なテンプレートがあまりないのは現場毎に作ったほうが良いという経験則だと思います。

あと、進捗管理に関しては様々なツールが存在して説明しきれません。

投稿2017/08/14 14:23

iwamoto_takaaki

総合スコア2883

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

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

0

ベストアンサー

一言で、仕様書といっても様々なものがあります。
あなたの会社やプロジェクトにとって、どんなものが必要かはわかりません。

開発会社に所属したことがなく、仕様書自体を見たことがないということだと、なかなか難しいとは思いますが、大き目の書店にいくとそういったものの解説本があるかと思うので、1冊買ってみて読んでみるのがいいかもしれません。
そのうえで、実際どんなものか見たいということであれば、EC-CUBEというオープンソースのショッピングサイトのシステムの仕様書が、検索すれば出てくるかと思いますので、参考にしてみるといいかもしれません。

また、アジャイルということだと、個別にドキュメントとして文書化しない(ゼロというわけではなく文書化が最小限)ような手法もあります。
いろいろありますが、チケット(TODOリストのようなもの)で進捗や仕様を管理する手法です。(Backlog,redmineなど)。バージョン管理システムに内包しているものもあります(github,gitlabなど)
ただ、全員が開発者、開発経験者ならそれでもいいと思いますが、全く経験がないような人にはまず受けれれてもらえないと思ったほうが良いと思います。

投稿2017/08/14 14:11

CodeLab

総合スコア1939

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

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

0

まずアジャイルという手法が非開発者には相当受け入れられない手法だということは頭に入れておいた方がいいです
言い方悪くいうと「物事の結論はできるだけ先延ばし、成果物はできたものだけ」みたいな捉え方をされる場合があります

社内向けに開発仕様書を作成するのですが、ネットのテンプレートを見ると具体的な中身を書いておらず、社内での過去の仕様書の様式に従って書いているのではないかと想像しています

あくまでもテンプレートはテンプレートで、具体的な内容は開発する案件に依存するものだからではないでしょうか?
派生する案件なら過去のコピペですが、新規の案件なら書き起こす場合が多いと思います
もちろん過去の蓄積が沢山あればコピペする素材も充実しているとはおもいますが

まずは開発工程でSEが書く文書の基本あたりを熟読されてはどうでしょう
加えてインハウス開発の場合のドキュメント類は必ず社内の言葉で書くようにしましょう
特に何をもってできたことにするのかはきっちりやっておかないといけませんね

あと自分を守ってくれる理解ある上司を見つけておきましょう

投稿2017/08/14 07:30

dojikko

総合スコア3939

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

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

0

こんにちは。

開発におけるドキュメントについては、学問になってもおかしくない位奥深く膨大なものです。

仕様だけでなく進捗とのリンクも必要になり、維持のための工数も考慮したレベルのドキュメントである必要があります。

質問者さんがどの程度のものを求められているのか分からないので、「アジャイル 開発ドキュメント テンプレート」あたりで確認してみて下さい。

進捗に関しては、今すぐ使えるとは思いませんが、今後を見据えてこちら(開発マイルストーン)を紹介しておきます。

---追記
レベルは高くなりますがこちら(プロジェクト管理ツール)のようなものもあります。
資金が潤沢ならこちら(msProject)も。
その他にも「ガントチャート」などのキーワードで検索すれば色々あります。

投稿2017/08/14 02:26

編集2017/08/14 02:45
sazi

総合スコア25138

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

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.50%

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

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

質問する

関連した質問