Main Contents

Apple Store(Japan)

ソースコードとドキュメントの管理

僕の開発環境(いちばん多用しているもの)


OS
Mac OS X 10.4
開発言語
Java SE 5.0
IDE
Eclipse 3.1.1
モデリングツール
Jude
SCM
Subversion

と、こんな感じなのですが、最近頭を悩ませているのは、ドキュメントの管理です。
いままで、適当にテキストファイルを作ってまとめていたのですが、どうも効率が悪い。
かといって、Wordみたいにバイナリファイルができるのは、バージョン管理しにくいのであまり好きじゃない。
Subversion を使っているので、バイナリでも差分でバージョン管理できるのだけも、diffつかって差分とれないから、あまり好きじゃないのです。

開発の上流行程の鍵を握るのは、ユースケース記述だったりするので、このあたりをしっかりまとめたいのです。


  • テキストファイルで管理できること
  • 大規模になり、大量の文書を抱えるようになってもメンテが楽なこと
  • 視覚的にわかりやすいこと
  • バージョン管理できること
  • 変更に強いこと
  • できれば、独自実装ではなく、すでに作られたもの。オープンソースで管理されているもの
  • Emacs で書けること

条件をあげると、これくらいでしょうか。
UMLモデリングツール Jude Professional には、ユースケース図にユースケース記述を連携させて記述することが可能です。
しかし、ASCIIファイルで管理できないことが難点です。XMIに出力するとASCIIで管理できますが、ユースケース記述はサポート外となってしまいます。

いま、XMLでうまく管理できないか考えてます。
XSLスタイルシートを使えば、見やすく表形式にもできますし。
DocBookもいいかなぁ。

この辺はもっと勉強せねば。。。

2006-04-23 追記

今日のエントリー に書きましたが、 SmartDoc を使い始めました。 書きやすく、出力フォーマットも柔軟性抜群で、かなり良い感じです。

TrackBacks

トラックバックURL:

Comments

Post a comment

(Think Different. では不適切なコメントを防止するため、コメントを掲載する前に管理者がコメントの内容を確認しています。コメントを初めて投稿する場合すぐに掲載されませんが、管理者が適切なコメントと判断した場合コメントは直ちに表示されますので、再度コメントを投稿する必要はありません。)

コメントフォーム

Copyright © here.Creative Commons LicenseThis weblog is licensed under a Creative Commons License.