Subscribed unsubscribe Subscribe Subscribe

じゃあ何が良いか

目的に有ったツールを使うべきと言ったものの、では何がいいのかなと。
システムの設計時に求められる設計ドキュメントと、システムの利用者であるユーザに提供するマニュアルの2つについて考えてみる。

設計ドキュメントの性質として以下のようなものが有ると思う。

  • 複数人で編集することが多い
  • 基本的に内部向けなので、見栄えのよいスタイルは重要ではない
  • 他のドキュメントへの関連がある
    • そのドキュメントのINPUTになったものとか
  • 容易に参照・編集できることが重要
    • 簡単に参照できるような形になっていなければただのゴミ
    • また、編集も簡単にできないと実体と乖離していきこれまたゴミとなる

このような物には、Wikiが良いと思う。特に、TracRedmineのWikiは構成管理ツールとも連携しているのでかなり強力。複数人で編集もできる。検索機能も大抵のWikiには付いているので容易に参照もできる。リンク機能も強力なので、別のドキュメントに参照を張るのも容易だ。編集が気楽にできるというのも良い。ちょっとした間違いであれば、すぐに修正して全体に公開することができる。