「ドキュメントの書き方」を体系的に学んだことがないエンジニアへ　書籍『エンジニアのためのドキュメントライティング』の概要

2023/08/28 706 users ドキュメント エンジニア 書籍 概要 登壇

インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く　エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。まずは、本書籍の概要について話します。 本セッショ... 続きを読む

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

2023/05/10 22 users エンジニア ドキュメン www.amazon.co.jp

エンジニアのためのドキュメントライティング読みました。 最近の仕事の悩みに対して、方向性を示してくれた良い本でした。 www.amazon.co.jp 自分のチーム内にドキュメントの文化が無い人にお勧めします。 全体のざっくりした感想だと、この手の本にありがちな小言っぽいことは書いてなく、作って意味のあるドキュメン... 続きを読む

読み手を意識したテクニカルドキュメントを書くために /「エンジニアのためのドキュメントライティング」を読んだ - kakakakakku blog

2023/03/20 13 users 原著 本書 エンジニア kakakakakku blog 出版

2023年3月に出版された「エンジニアのためのドキュメントライティング」を読んだ．原著は Docs for Developers で，翻訳を担当された @iwashi86 さんに本書を送っていただいた．ありがとうございます❗️そして出版おめでとうございます🎉 本書は今まで書いてきたテクニカルドキュメントに対して "できてなかったな〜" と... 続きを読む

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

2023/03/17 223 users エンジニア Docs for Developers

なぜ変化を起こすのが難しいのか？ - 数年以上にわたって難しさに向き合い・考え取り組んできたこと / The reason why changing organization is so hard - What I thought and faced for more than several years 続きを読む

良いドキュメントを書きたくなる本を読んだらドキュメンタリアンになりたくなった - じゃあ、おうちで学べる

2023/03/14 445 users SRE 良いドキュメント 書評 役職 ドキュメント

ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私は所属しているSreake事業部でSREをして... 続きを読む