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

ドキュメンタリアンとは、役職に関係なく、ソフトウェア業界でドキュメントとコミュニケーションに関心を持つ人のことです。 www.writethedocs.org はじめに これは主に『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。私はSreakeにてSREという役職についています。SREはサービス概要、アーキテクチャの解説や図、各種構成図、各種手順書、ポストモーテム、ポリシー、SLA(SLO) … その他の様々な場面でドキュメントを書く必要があります。しかし、ドキュメントは価値が見えにくく時間と労力がかかり品質担保の面で重要度がとても高いのにその場での価値が見えにくいので浸透しにくいです。そのため、エンジニアとしてモチベーションが保ちづらいです。2021年 State of DevOps 2021 にもドキュメントに関する言及があり今後、

[syu-m-5151]

『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の書評です。ドキュメントについて悩んだことのあるエンジニアにとってはめちゃくちゃ良い本。

[jassmaz]

基本のパラグラフ・ライティングをやれ。欧米の高校生や大学生は全員やらされるから欧米製品のマニュアルが読みやすくなる。紹介本の作者達も教育機関で訓練済み。ブルーバックスの倉島保美先生の著書がおすすめ。

[kazuya030]

タイトル、本に対するめちゃくちゃいい褒め言葉だな。

[ALM0ND]

良いドキュメントについて学び直したい時に。 今年中に読みたい。

[naka-06_18]

きになる

[tankdesant]

米国製品のマニュアルが読みやすいってブコメがあるけど、AWSとGCPのドキュメントはひどいもんだよ

[k1LoW]

良いドキュメンタリアンになりたい

[remix-cafe]

めも

[fujii_yuji]

この本良さそう。エンジニアじゃないけど買った。

[okami-no-sacchan]

非IT人間にわかるように「ドキュメント」を定義してから語ってください

[udofukui]

あとで買おう

[eigo_s]

良さそうな本なので買おう

[xKxAxKx]

きになる

[noikari]

自分は昨日読み終えましたが、とてもいい書籍でした！

[aramaaaa]

ドキュメンタリストは、ドキュメンタリー制作者のことなので注意