レクチャーや勉強会をきっかけにドキュメントを作ろう
「ドキュメントがあるのにそれで学んでくれない」というのは、あるある ドキュメントには2種類ある
結論はあるけど、そこまで理解していくステップがない
読み手に知識とスキルが求められる
周辺知識を自分で集めて、プロセスを自分で埋める
プロセスもある
その結論に辿り着くまでのプロセスが、読みやすく存在する
知識がない読み手でもOK
一歩一歩理解できる
あなたが「完璧なドキュメントだ」と思っていてもそうじゃない可能性は高いsawachin.icon
自然に作ると、ドキュメントは辞書になる
「自分の、チームメンバーの備忘録」が目的になるから
教科書がないから、レクチャーや勉強会が必要
「知識ない人に一歩ずつ理解してもらう」ための流れになるから
引き継ぎのときにレクチャーを作ることになるのはこれが理由
だから、「ドキュメントを読んで勝手に育ってもらう」ためには
まず、引き継ぎ(レクチャーや勉強会)をして、
シンプルでいい
その場の質疑応答・感想をしっかり書き取り
これで、「誰でも理解できるドキュメント」になるsawachin.icon