仕事でマニュアルのような手順を記載したドキュメントを書く時、常にメンテナンスを意識しておく必要がある。メンテナンスと言うと抽象的でわかりづらいので、自分の思いつくアンチパターンを雑にまとめておこうと思う。 タイトルに日付をつける 日が経つにつれて似たようなドキュメントが増えていく。1つのドキュメントを常に最新にしておく方がよい 補足・修正内容をコメントに書く ドキュメントサービスによるが、コメントで補足や修正をすると見落とされる。本文を更新する方がよい 定期的に見直すタイミングや担当が決まっていない 程度の差はあれ、ドキュメントの内容は必ず古くなる。その前提で定期的に見直すタイミングや担当を決めておく方がよい バイネームの記載がある 担当が変わって情報が古くなるみたいなことになりがち。ドキュメントだけの問題ではなくチーム課題かもしれない 文章が冗長 これは人によって感覚が違うので難しい。よ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く