マニュアルの役割って何でしょう?

CVS操作マニュアル』は,CVSサーバの設定をした人が作ってくれました.
隣のプロジェクトが既に使用していたので,そのから設定を聞き,更にeclipseで使う時の設定や使い方などをまとめて貰ったのですが,これが何とも不評で困ってしまった.
eclipseからCVSサーバを使える様にするところまでは問題ない.
でもそれって大抵の人は一回しかやらない部分.
重要なのはサーバ側を更新したり,サーバー側に新規追加したり,クライアント側のものを破棄してサーバの物を持ってくるとか,そんな雑多な作業のはず.
それなのに,通り一遍な更新の方法は書いてあるけれど,それだけ?(ё_ё)

「マニュアルを作ったので各自設定して使ってください」 と連絡は来たものの,その後疑問/質問が噴出した.

  • 競合したときはどうするの?
  • 元に戻したい時は?
  • 前のバージョンと比較したい時はどうすればいいの?
  • 更新すると自分が編集中の物はどうなるの?
  • 新しいプロジェクトを追加したいんだけど,どうやるの?

熟知した物でなければ,初期段階から全てを網羅したマニュアルを作るのは難しい.
でも「どこまでが当面必要か?」ということは考えなくてはいけない.
CVSとは何する物ぞ? と考えれば,必然的に必要な項目は見えてこようという物だ.
マニュアルがあるにも関わらず,設定直後から問題が噴出する様では,マニュアルがその任務を果たしせていないことは間違いない.