/note/tech

マニュアルドキュメントアンチパターン

  • タイトルに日付をつける
  • 補足・修正内容をコメントに書く
  • 定期的に見直すタイミングや担当が決まっていない
  • バイネームの記載がある
  • 文章が冗長
  • 全員見れるべきものが見れない
  • スクショの過度な多用

分かりみが深い。

他にも「対象読者を絞れていない」だとか「過剰な図」とか色々あるので自分でもまとめてみたい。