究極のドキュメント管理を考える 1(FC2に場所確保)

究極のドキュメント管理を考えてみる。
ドキュメントとは、
あるシステムやプログラムの仕様に関する説明書や
チュートリアルなどの公式文書のこと
と定義する。このようなドキュメントを常に最新にしたり、
理解しやすいものにしていくことは、うまくやらないと
ものすごい労力と時間を使ってしまうことになる。

というわけで、何回かにわけて、
究極のドキュメント管理について考察してみたいと思う。

まず、ドキュメント管理について、望ましくない状態とは
  1. 保存形式が特定のソフトに依存したバイナリ形式である
    • Word, Excelで書くと、基本的にそのソフトがないと編集、参照できないから
    • バイナリ形式なので、diffが確認できずにバージョン管理できないから
  2. テキスト形式でもpukiwikiのようにブラウザ上で編集+更新する運用である
    • emacsやvimで編集する方が楽だから
    • pukiwikiのデータ保存ディレクトリに置かずに、svn/git管理下のディレクトリで編集していたいから
    • ツール上で権限管理などの機能が必要になってしまうから
  3. すべて手動で更新しなければいけない
    • コードのコメントなどとは別にドキュメントを新たに1から用意するのは面倒だから
    • 目次作成や見た目調整などドキュメントの本質とは関係ない時間をとられるから
といった状態だと思う。(自分のこれまでの経験から判断)

これから判断して、
究極の(かどうかはまだわからないが、望ましい)状態って
以下のような状態だと思われます。
  1. いつでも参照可能
  2. 読みやすい
  3. 編集しやすい
  4. バージョン管理されている
  5. makeによる一括作成
  6. 複数フォーマットサポート(html, pdf, etc.)
というわけで、まずは1.を満たすべく、css-reneでも使ってるFC2 webに
ドキュメント置き場を確保しました。
http://tanarky.web.fc2.com/

FC2 webだと
  • 容量が1Gもあるので、テキスト形式ドキュメントだと実質使いきるのは無理
  • ネットにつながれば誰でも閲覧可能
  • FTP接続できるので、アップデートが楽
場所が確保できたので、これから究極のドキュメント管理について
具体的な手法や採用する技術、運用ルールなどを考えていこうと思います。

千疋屋総本店 究極モンブラン(4個入)

千疋屋総本店 究極モンブラン(4個入)