概要
Crafting Docs for Success : An End-to-End Approach to Developer Documentationを読みました。 感想を書きます。
前提
目的
本書を読んだ背景は以下です。
- 技術的な英語の勉強の一環として、英語の技術書を毎月 1 冊読むことを目標にしていた
- 内容的に Docs as Code は興味がある分野で、オライリーのサブスクリプションにもあったので、読むことにした
事前知識
おそらく、最も適切に定義されている Docs as Code を読んで、Docs as Code の定義は把握していました。 また、我流ですが docusaurus を利用して、社内ドキュメントを Git 移行していました。
読了時間
とりあえず英語で一度読み、内容が難しければ DeepL 翻訳を利用して翻訳して読むというやり方でだいたい 15 時間ぐらいで読みました。
感想
Docs as Code の基本的な部分から実践的な部分まで記述された書籍でした。 具体的には以下の内容です。
- Docs ad Code の実践方法
- UI/UX の考え方
- 一般向けのドキュメント
- アクセシビリティ
- ドキュメントの持続性
- 文化・コミュニティ
個人的な印象として Docs as Code の対象範囲は技術者向けドキュメントの印象が強かったのですが、本書がカバーした範囲はそれ以上でした。 自身の範囲ではすべてを実践する機会はありませんが、一分野として洗練されているものとして勉強になりました。
似たような書籍に以下の書籍がありますが、本書も含めどれか 1 冊を読めば良いと思いました。
次に関連で勉強すること
引き続き英語の技術書を読みます。
