開発ドキュメントの管理

開発ドキュメントの管理

これらの開発ドキュメントを読者の皆さんは、どのように管理しているだろうか。

例えばファイルサーバやWikiなど、情報を集約するシステムやツールによって、企業の共有財産として管理している例も多いと思われる。またご自身のクライアントPCで独自に管理している方もいるだろう。

整理の方法としては、それぞれのファイルを案件ごとに区分して階層構造を作ったり、ドキュメントの属性で区分したりして管理することになる。ファイルの名前には日付やバージョンを記載し、管理しているだろう。

では、そららを有効的な再利用できているだろうか。実はここには大きな障害がある。それはさまざまなツールなどによってバラバラなファイルで蓄積されていることである。

いざ再利用をしようと考えたとしても、データ型が違ったり、フォーマットが異なったりして、変換や整形で苦労することがある。それならば、 自分が使いやすいもので再び作った方が早かったなどの経験はないだろうか。個人で管理している場合、○○のドキュメントは○○でと決めていることだろう。 そのため、個人にノウハウがたまっていくのである。実際に、情報共有しているようにみえて、意外とそれらのファイルが使われていなかったりすることがある のはそのためだ。

管理にあたっても統一されたものがあると非常に便利だ。Excelで統一するというのは、管理の意味でも効率的である。では、他にどのようなアプローチがあるのだろうか。

XMLで書くということ

本連載では「XML（Extensible Markup Language）」を取り上げてみたいと思う。

読者の皆さんもご存じのように、XMLとはWWWの標準を定める団体「World Wide Web Consortium（W3C）」によって1998年2月に勧告された国際標準の構造化文書の技術で、汎用的に使うことができるマークアップ言語である。 XMLは階層構造で表現され、さまざまな種類のドキュメントの表現に向いているといわれている。このXMLによって、開発ドキュメントを書くのである。

さまざまなドキュメントを表現できることから、その標準化にも向いているといえよう。また、再利用という観点から考えると、まったく別のドキュメントを参考にできる可能性もある。また、国際標準であり、幅広く使われていることからも、その利活用の幅は広いと考えられる。

XMLに対しては、デメリットもあることは確かだ。またWordやExcelによるドキュメント作成のノウハウが非常に多く蓄積されていることもわかる。がしかし、まずは実際に適用して試みてみることが重要だ。

そのような理由から本連載では、大学の情報システムの例をもとにXMLの活用について取り上げる。ご執筆いただくのは佐賀大学総合情報基盤 センターの只木 進一先生だ。2008年2月12日（火）公開の「第2回：情報システムの仕様をXMLで書く」を楽しみにしていただきたい。