チームに伝わるドキュメントの書き方講座

はじめに

「せっかく書いたドキュメントが読まれない」「質問が減らない」
そんな悩み、抱えたことはありませんか？

エンジニアとしてある程度経験を積むと、コードを書く以外の仕事——とくに「伝える仕事」が増えてきます。その代表がドキュメント作成です。

僕自身、チームのため、クライアントのためにドキュメントを書いてきましたが、「ちゃんと書いたのに全然使われない」「伝わらない」という失敗を何度も経験してきました。

この記事では、そうした失敗のなかで気づいた、「伝わるドキュメント」を書くためのコツを、実体験ベースでお届けします。

ドキュメントは「書く」だけでは意味がない

初心者のうちは「まずは書こう」でよかったと思います。
でも中級以降は、「活用されて初めて意味がある」という視点が欠かせません。

たとえばこんな失敗、ありませんか？

・ 頑張って設計書をまとめたけど、チームメンバーに「どこにありますか？」と聞かれる
・ クライアントに共有した資料が「意味がわからない」と言われる
・ 数ヶ月後に見返したら「これ、何のために書いたんだっけ…？」となる

続きは、リベシティにログインしてからお読みください

＼初月30日間無料／ リベシティで会員登録をする ログインする

ノウハウ図書館でできること

• すべての記事の閲覧

• ブックマーク

• いいね・レビュー

• 記事の投稿※応援会員（有料）のみ

• ポイントの獲得※応援会員（有料）のみ

※会員登録には、新入生会員（初月30日無料）と応援会員（有料）があります

応援会員制度とは？

さらに！

• リベシティの他の機能やサービスもご利用いただけます（詳しく見る）