ドキュメント作成に関する書籍・リンクまとめ

ドキュメントの書き方

 エンジニアだと、どうしてもコードを書くことに注目が行きがちですが、コードと同様に重要なのがドキュメントを書くことと思います。仕事に必要なドキュメント(仕様書、マニュアル)、からライトな技術メモ、技術ブログ等、書くことに苦手意識を持っている方も多いように思います。そもそも、ドキュメントの書き方、教わることがない人も多いのではないでしょうか?

 そんな人のために、ドキュメントを書く方法についての情報をまとめてみました。ほぼ自分のためのメモではありますが、何かの参考になれば幸いです。

書籍

書籍の紹介です。Amazonアフェリエイトリンクがありますので、嫌な人は別のリンクから購入ください。

エンジニアが一生困らない ドキュメント作成の基本

技術的な文章(ブログや書籍)の書き方が、体系化されています。生成AIを使って文章を書く章もあり今風ですね。どう書いてよいかわからない人向けの本です。

エンジニアのためのドキュメントライティング

 ドキュメントの書き方にとどまらず、その後のフィードバックのもらい方、品質定義・測定、運用まで書かれている書籍です。リファレンス的なものをどう作成して、継続的に品質を維持するかというときには役に立ちそうです。

 もうちょっとライトに、技術文章を書くヒントが欲しいという期待感で読むとミスマッチになるかもしれません。

リンク

テクニカルライティングの基本 2023年版 - Speaker Deck Cybozuさんのテクニカルライティングの研修資料です。よくまとまっています。

LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた LINEのテクニカルライティング講座の内容をブログにまとめたものです。3つの記事からなる大作です。

新しい「公用文作成の要領」に向けて(報告)
公用文作成の要領です。漢字のひらき(平仮名にすること)をするか迷ったときなど、文章を書くときの指針の一つとして参考になるかもしれません。

伝えたい人に届ける技術記事の書き方 #記事作成 - Qiita
技術記事の構成、ポイントについて書いた記事です。最低限のポイントを抑えたいときに。

論文の書き方リンク
論文の書き方についてまとめたリンクです。論文の書き方は、技術文章とはまた違ったものになりますが、共通する点も多いと感じています。参考になれば幸いです。

エンジニアのためのドキュメントライティング / Docs for Developers - Speaker Deck
エンジニアのためのドキュメントライティングについてのスライド

まとめ

 ドキュメントの書き方について情報をまとめてみました。一般的な文章の書き方に関しては以前ブログ記事にまとめているので、技術文章以外(普通のブログ等)を書きたい方は、そちらも参考にしていただけたら幸いです。

 そもそもなぜ技術文章や文章を書く必要があるの?といった情報発信の重要性については拙作の以下記事参照いただけましたら幸いです。

参考リンク

文章どころか仕事全体の質も上がる『エンジニアが一生困らない ドキュメント作成の基本』|ミノ駆動

ドキュメントを書くハードルを下げてくれる本『エンジニアが一生困らないドキュメント作成の基本』|masuipeo

関連記事