見出し画像

エンジニアだけではもったいない!製品開発のためのドキュメント作成~運用マニュアル

こんにちは、noteコーディネーターの玉岡です。
本日紹介する書籍はこちら。
本書はその名のとおり、ウェブサービス等の製品開発においてドキュメントを作成するエンジニア、プロダクトマネジャー等に向けてドキュメントの作成~保守の流れを詳細に解説しています。

本書に登場する「Corg.ly」とは、犬の鳴き声を人の言語に翻訳するサービス名。そのチームメンバーがサービスローンチに向けて奮闘する姿が、仮想ケースとして各章を通して描かれます。
目次構成は以下のとおり。


PART I ドキュメント作成の準備
CHAPTER 1 読み手の理解
CHAPTER 2 ドキュメントの計画

PARTⅡ ドキュメントの作成
CHAPTER 3 ドキュメントのドラフト
CHAPTER 4 ドキュメントの編集
CHAPTER 5 サンプルコードの組み込み
CHAPTER 6 ビジュアルコンテンツの追加

PARTⅢ ドキュメントの公開と運用
CHAPTER 7 ドキュメントの公開
CHAPTER 8 フィードバックの収集と組み込み
CHAPTER 9 ドキュメントの品質測定
CHAPTER 10 ドキュメントの構成
CHAPTER 11 ドキュメントの保守と非推奨化


一度でもウェブサービスの開発に携わったことのある人なら、「ああ、あのフェーズね」と連想できる構成ではないでしょうか。

卓抜のSTORYパート

各チャプターの冒頭では、このように「Story」パートが展開されます。

画像

このStoryが秀逸。
例えばチャプター1ではサービスローンチ直前の時期に、開発メンバーは「改めてユーザー視点でサービスを見直したら、導入へのハードルが高いのでは?」という疑念を持ち始めています。

では、本来どうすべきだったのか。ここからどうするべきなのか。
そのための実践的なテクニックが、明確なテキストで解説されます。本書は解説書、技術書というよりも、歴然とした「マニュアル」だと言えます。
マニュアルに書いてあるとおりに実践すれば、サービスローンチまでに組織内で作成すべき文書、集めておくべき情報、検証しておくべき条件が明確化できるでしょう。

「マニュアル」として読める

またチャプター5では実際のサンプルコードも例示され、本書が概念のみの解説に終始しない、「マニュアル」であることが分かります。

画像


プレゼンテーション、プロジェクト管理にも有効

本書には、ウェブサービスの開発だけではなく、一般的な社内外プレゼンテーション、プロジェクト管理への有用なTIPSも含まれています。
たとえば以下のSTORY。

画像

チームや顧客に齟齬なく情報を伝えるためにはビジュアライゼーションが必須。しかしその作成には技術が要ります。
チャプター6で解説されるビジュアルコンテンツ作成技法は、きわめて実践的です。

「保守」とは何か

最終章である「ドキュメントの保守と非推奨化」では、リリース完了後のサービスにバージョンアップ等の仕様変更が発生するケースを取り上げます。
個人的には、このチャプター11で解説される「ドキュメント保守」のくだりが最も印象的でした。
STORY「いくつかのリリースのあと」に続く「ドキュメントを最新の状態に保つ」から「ドキュメントの保守を自動化する」は、プロジェクト管理に携わる人なら必読です。あなたの仕事にも、多くのトイルが内包されていないでしょうか?

画像

本書で引用されている多くのツール、参考文献なども、アペンディクスとして巻末に掲載されています。ぜひ参照してみてください。

いいなと思ったら応援しよう!

コメント

ログイン または 会員登録 するとコメントできます。
エンジニアだけではもったいない!製品開発のためのドキュメント作成~運用マニュアル|人と組織が育つ本/JMAM(日本能率協会マネジメントセンター) 出版部
word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word word

mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1
mmMwWLliI0fiflO&1