自分たちでサービスの開発と運用をしているチームで、僕がどんなことを考えながらドキュメントを残してるかなぁってのをメモ。結論から来月の自分が読んで分かりやすいなと思えるドキュメントを残す。タスクをやってる最中は雑にメモタスクをやってる最中は雑にメモを残していく。体裁は気にしないでとにかく気軽に気づいたことや学んだこと、これは来月の自分に残しておきたいなってことをメモしていく。ここで大切にしたいのは情報を残すこと時間をかけないこと避けたいのはきれいにかくこときれいに書かなきゃと思って、内容じゃなくて見た目に時間を取られること書くの面倒だから、あとにしようってしてしまうことということで、走り書きの雑なメモができあがる。大切なことは全部書いてある。次はまとめるタスクがひとくぎりついたら、メモを見ながらまとめる。ここで考えるのは、書く人の気持ちじゃなくて、読む人の目線。僕は、来月の自分のことを考えながら書く忘れっぽくて、今やったことも明日には忘れてるしドキュメントを読むのが苦手なので分かりやすく書いてないと頭から煙がでるから、自分を想像しながら書けばいいので便利。複雑なものは図をひと目見たら伝わるようにするだけど、これも全ての詳細を図に盛り込むんじゃなくて、伝えたいことに焦点を絞った図。1ページが長くなりすぎないようにする。読んでるうちによく分からなくなるから。いってページ数が多くなりすぎないようにする。それから、ページの階層が深くなりすぎないようにする。どこまであるんや、って迷子になるから。それから削除するまとめ終わって要らなくなったメモや、重複する部分は削除する。削除は後になればなるほど「消しても大丈夫なのかな?」ってのが分からなくて難しくなる。コンフルエンスを使ってるので、削除したページはゴミ箱に入るから、やっぱ必要だったわってなっても戻せる。情報を残すときに、最後の結果よりも、過程が重要な場合がある。いうときは、結果だけじゃなくて、その過程をドキュメントとして残すことが大切。まとめということで、ドキュメントを書くときは「書き出す」と「まとめる」を分ける書く人の気持じゃなくて、読む人のことを考えて書く重複する情報は削除する過程が重要な場合は、結果だけじゃなくて過程もドキュメントとして残すって感じか。あれ?これ、コードと一緒だ。動くようにしてから、リファクタリング読む人のことを考えて書く重複は削除コードにあらわれてこない部分をコメントに残しておくドキュメントのことを考えてると思ったら、コードのことを考えてた。スクラムフレームワークを使用する具体的な方法。(前編)「スクラムフレームワークを使用する具体的な方法。頭の中にスタックが3つしかないからネストは3つまでがいいし。(1)はてなブログをはじめよう!bufferingsさんは、はてなブログを使っています。ブログを報告するスターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。