ドキュメントの書き方
#ドキュメンテーション
運用のリソースを食う割に対価を実感するのが難しく、腐っていくのがほとんど
結局人で管理する部分が残るのであれば、陳腐化する
「なにをドキュメントにするとよいか」？の判断は難しい
読み手の心情と伝えたいことの価値、その賞味期限を意識せねばならない
無いと困るものから考える
言語化
人は能力の100%は出せない、教えるのは猶更だ
オンラインでの発信は多かれ少なかれ情報の欠落が発生する
問題をゼロにすることを目標にしていない、制御できてるならそれでいい
なぜドキュメントを書かない？
テクニカルライティングの基本
文章の書き方を解説するための記事
【汎用ソフトスキル】ドキュメンテーションの続け方
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい
“知識の呪い”にかかってない？ 優れたドキュメントづくりの第一歩は「読み手を理解する」ことから
#知識の呪い
設計資料は、システムそのものを全部書き出した文書じゃない
HTTPキャッシュに学ぶ、無理のないドキュメント更新運用
設計ドキュメント腐る問題、Git管理で運用してみた結果 | フューチャー技術ブログ
Notion大臣
---
#AI
LLMsをコミュニケーション媒体にする