システム開発にドキュメントは欠かせません。ドキュメントが得意になれば活躍の幅が大いに広がりますよね。

この記事では、まず冒頭でドキュメントの作成に求められると思うことを整理した上で、そのスキル獲得に役立つと思われる記事を集めてみました。もちろん他にもあると思うので、もしお薦めのものがあれば是非コメントで教えて下さい

システム開発系ドキュメントの作成に求められること

システム開発系ドキュメントの特徴

• 自分以外の誰かが、参照更には更新する可能性がある資料である

  • レビュワー
  • 後工程の担当者
  • 保守担当者

• 抜け漏れや、読み手によって解釈が異なることは許されない

  • 検討すべきことの抜け漏れは、要件の未達成から手戻りにつながる
  • 解釈が異なる記述をしてしまった場合も同様に、後工程の不具合につながりやすい

• 納期があり生産性が求められる

  • 書き手が納得いくまで時間をかけて良いわけではないので、生産性を高める工夫が必要
  • 事前に作成にかかる工数の見積りが求められる

システム開発系ドキュメントに求められること

• 品質（特に当たり前品質）

  • 誤字脱字、最低限の体裁、表記統一
  • 書くべき項目がすべて書かれている
  • 内容が正確

• 読み手にわかりやすいこと

  • 全体構成、見出しの粒度、順序が適切
  • 文章としてわかりやすい
  • 体裁が適切に「デザイン」されていること
    • タイトル、表紙、インデント、ページ番号など
    • ドキュメントの要件に合った適切なツール選定

• 生産性や作業管理性が高いこと

  • 標準化され一定のルールがある方が書きやすい
  • 作成にかかるタスクが分解できている（見積りの精度が上がる）
  • 完了までの段取りが出来ている（アウトライン化）

おすすめ記事

文章術系

誰がどう見てもそうとしか受け取れない文書術（公開版） - Speaker Deck
「伝わる」ためには何が必要かがコンセプトから実践レベルまで書き込まれた珠玉の文書作成ノウハウ集。必見。

誰にでも分かるSEのための文章術 - ＠IT
元SEのライターさんによる全15タイトルからなるドキュメント作成に関する記事群。目次の大切さが何度も出てきます。

前提知識系

要望・要求・要件・仕様・制約・前提の違いは？
システム開発に頻出用語ながら定義があいまいになりがちな言葉を明確にすることができます。

構造化とは｜構造化の意味と【5つの構造化思考】を徹底解説 - Mission Driven Brand
高品質なドキュメントを作成する上で欠かせない構造化思考の考え方が学べます。

【9割の人ができない】「仕事が遅い人」がやっていないたった一つのこと | まこなりの社長室
ここで述べられているアウトラインから考える思考は、ドキュメント作成というタスクについては特に重要ですね。

プロジェクト方法論系

はじめての要件定義で読むべきIPAドキュメント - Qiita
IPAのドキュメントは色々参考になりますね。要件定義初心者は必見！

今、システム開発の実態はどうなっているのか | Think IT（シンクイット）
2020/04/08現在まだ連載中。ツールの紹介側面もあるが、システム開発におけるドキュメント作成の位置付けがよく理解できます。

チェックリストでリスクを見つけてプロジェクトを幸せにしよう
プロジェクトにおけるドキュメントに関するアンチパターンが学べます。（3.11.など）

要件定義基礎研修テキスト | Fintan
TIS株式会社のノウハウ公開サイトより。大規模システム向け。このコンテンツ以外もサイト全体が諸々参考になります。

エンジニアさんのノウハウ系

エンジニア歴20数年の私が、設計書を書く際に心がけていること - Qiita
ベテランエンジニアならでは実務目線かつ網羅的な記載。でも読みやすいです。

仕様書の書き方 - Qiita
シンプルですがポイントを抑えています。書く内容を必要最低限に絞りたい時に参考にすると効果的です。

スライドデザイン系

エンジニアのためのスライドデザイン実践講座 / How to design presentations for engineers - Speaker Deck
かっこいいスライドを作って、どんどん発信しましょう！

おすすめ書籍

まんがでわかる　理科系の作文技術 | 木下是雄, 久間月慧太郎 | ビジネス・経済 | Kindleストア | Amazon
読みつがれる名著のマンガ版です。ハードルがぐっと下がりました。是非お薦め。

文章を書く上で参考になった本 3冊｜中野康雄＠ARI｜note
ビジネスドキュメントというよりも文章という意味ですが、自分のお薦め本を3+1冊挙げた記事です。

--

今のところ以上ですが、他にもいろいろあると思うので是非教えて下さい！

追記（2020/04/09）

社内研修用に用意した資料も公開しました。
よろしければ併せて参考にしていただければ幸いです。

エンジニアのためのドキュメント力基礎講座 - Speaker Deck