読みやすい開発者向けドキュメントとは？

仕様書、ヘルプファイル、Webサービスの開発者向けガイドなど開発者向けにドキュメントを書くことがよくあります。せっかく書いたドキュメントが全く読まれていなかったり、逆に人が書いた文章がとても読みづらく感じることはないでしょうか。

そこで今回は開発者ドキュメントにフォーカスして読みやすくする方法を紹介します。

文体を統一しよう

読みづらい文章で最も多いのが文体の不統一です。ですます、だである文末の違い程度であれば良いのですが、突然へりくだった文章になったり、丁寧な文章になったりするのもよくありません。会話でたとえれば、突然横柄になったり丁寧になったりと態度がころころ変わる人を信用できるでしょうか。

文体を統一するには声に出して読んでみるのが一番です。そうすると突然違和感を感じる部分が出るはずです。