Help us understand the problem. What is going on with this article?

ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ

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

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

更新履歴

・2020/05/24:文章術系にリンクを追加しました。
・2020/05/14:スライドデザイン系にリンクを追加しました。
・2020/04/29:スライドデザイン系にリンクを追加しました。
・2020/04/17:文章術系にリンクを追加しました。
・2020/04/12:関連するTwitterのリンクとお薦め書籍を追加しました。

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

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

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

    • レビュワー
    • 後工程の担当者
    • 保守担当者
  • 抜け漏れや、読み手によって解釈が異なることは許されない

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

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

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

  • 品質(特に当たり前品質)

    • 誤字脱字、最低限の体裁、表記統一
    • 書くべき項目がすべて書かれている
    • 内容が正確
  • 読み手にわかりやすいこと

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

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

おすすめ記事や書籍

文章術系

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

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

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

技術者のためのテクニカルライティング入門講座|髙橋 慈子(2020/04/11追加)
構造化思考から業務で使うメールや文章の実践的なライティングノウハウまで、この1冊で丸っとおさえられます。チェックリストがいいですね。

社内で行ったビジネスライティング講座資料を公開します | Developers.IO(2020/04/17追加)
主にチャットや社内文書などのテキストコミュニケーションにおける注意点を中心に記載されています。日本語校正ツール/アドオンの利用は確かに効果的。私はMicrosoft Wordに貼り付けて波線チェックしています。

Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita(2020/05/24追加)
テクニカルライティングの原理原則の紹介です。是非多くの人に読んでもらいたいです。

前提となる知識系

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

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

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

エンジニアのためのドキュメント力基礎講座 - Speaker Deck(2020/04/09追記)
ドキュメント作成に不可欠な構造化思考に的を絞った拙作の社内研修用資料です。

システム開発やプロジェクト方法論系

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

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

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

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

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

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

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

スライドデザイン系

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

【プレゼン】見やすいプレゼン資料の作り方【初心者用】(2020/04/29追記)
プレゼン用スライドデザインにおける「イロハのイ」がちょうどよいボリューム感で語られている。タイトルの通りプレゼン初心者におすすめです。PPTユーザを想定していて、PPTにおけるデフォルトフォントの設定方法など効果的な利用方法の記載があるのは嬉しいですね。

PowerPoint資料作成 プロフェッショナルの大原則 | 松上 純一郎 | ビジネス教育 | Kindleストア | Amazon(2020/05/14追記)
コンサルティングや上流工程におけるPowerPoint資料の作り方についての網羅性で言えばこの1冊がよいです。著者のページから前半部分のPDFがダウンロードできる。気になる方はチェックしてみてください。

社内プレゼンの資料作成術 | 前田 鎌利 |本 | 通販 | Amazon(2020/05/14追記)
会議で人を動かすためのプレゼン資料が作りたい人はこの資料をみてください。ちょっと考え方が変わるかも知れません。

その他おすすめ書籍

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

【改訂第2版】[入門+実践]要求を仕様化する技術・表現する技術 ~仕様が書けていますか? | 清水 吉男 | コンピュータ・IT | Kindleストア | Amazon(2020/04/12追記)
要求仕様の言語化技術であるUSDMという手法を軸に、要求の仕様化技術を紹介しています。日本語の扱い方も参考になります。

なぜ重大な問題を見逃すのか?間違いだらけの設計レビュー改訂版(日経BP Next ICT選書) | 森崎修司, 日経SYSTEMS | 工学 | Kindleストア | Amazon(2020/04/12追記)
ドキュメントにレビューは不可欠ですが、そのやり方自己流という方も多いのでは?私もそうでした。レビューの正しく効果的なやり方を教えてくれる本です。

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

yasuoyasuo
Biz&Tech&Creative 三位一体型ITコンサルティング&SIのARアドバンストテクノロジ株式会社(略称ARI (http://www.ari-jp.com/ ) )取締役執行役員(コンサル&エンジニア&クリエイティブ部門統括)|ITコンサル、ネットサービス事業者から独立を経て現職。昭和49年生まれ双子座 O型兵庫県出身|PMP、情報安全確保支援士、AWS SAA
https://note.com/yasuoyasuo/n/n9d83c83ae921
ari-group
Biz&Tech&Creative 三位一体型でサービス企画、UIデザイン、アプリ開発からクラウド基盤や音声基盤の構築、BIやRPAなどのソリューション導入、各種保守運用までをワンストップで提供するITコンサルティングとクラウドインテグレーションをやっている会社です。渋谷、大阪、名古屋の国内3拠点体制で、FAQチャットボットなど自社サービスも展開しています。仲間を絶賛募集中です。
https://ari-jp.com/
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした