【学習記録】Design Docの存在を知った

今月から新しい現場に入り、まずはプロジェクトの概要であったりソースコード全体のアーキテクチャを理解することから始めました。
その時やはりドキュメントが整っているとありがたいなと実感して、良いドキュメントを書くスキルもしっかり高めたいと思いました。

それで休憩中に世の中のドキュメントのベストプラクティス的なものってどんなのがあるのかなと思っていろいろ検索してると、Googleなどで取り入れられているDesign Docという設計ドキュメントのスタイルがあるということを知っていくつか記事を読んでみました。

please-sleep.cou929.nu

www.atmarkit.co.jp

shimo5.me

snowlong.hatenablog.com

qiita.com

tkybpp.hatenablog.com

ソフトウェアの設計書は「テクニカルライティング」と呼ばれることも知れたので、今後ググりやすくなりそうです。

以下はGoogleが公開しているテクニカルライティングの資料とのこと。
時間作ってちょっとずつ読みたいと思います。

developers.google.com

「Every engineer is also a writer.」という言葉が印象に残りました。
自分もドキュメントを書くスキルを高めていきたいです。

個人開発したプロジェクトのドキュメントを書いて練習してみたいと思います。