テキスト形式で仕様書を管理したい

質問

普段仕事ではエクセルやワード等で仕様書を作成、管理しているんですが、
バイナリ形式のファイルではバージョン管理で前回のリビジョンとの差分が
見づらいという理由で、テキスト形式で仕様書を管理できないかと思っています。

とはいっても.txtに日本語で文章をつらつら書いていくのでは
たとえばファイル項目設計書や画面項目設計書のように表形式の記述法や
オートシェイプの吹き出し、矢印などによる付加情報が利用できない
というデメリットがあります。

そこで、たとえば表計算やその他のソフト（仕様書が書ければなんでもいいんですが）で
書式や罫線、オートシェイプのような情報も含めてXMLのようなテキスト形式で
保存できるものはありますか？

またはファイルがバイナリ形式でも専用の差分ビューワのようなツールで
差分を確認できるものはないでしょうか？

いいものをご存知でしたら教えていただきたいです。よろしくお願いします。

回答No.3

TooManyBugs

こういう事を考えること自体仕様書の管理が出来ていない証拠ですね。

文書の差分をとるなど本来意味がありませんね。
重要なのはいつ何のためにどこをどのように変えたかですから詳細な改版履歴を記述するなり、前の文字を削除せず抹線で残すなりすれば済むことです。

回答No.2

lupin-333333

なんか、この投稿、やらせのような気がしないでもないが・・・

＞XMLのようなテキスト形式で保存できるものはありますか？

これって、まさに現在のBlog等の、掲示板形式のWebアプリですよね。HTMLで保存するか、プレーンテキストで保存するか、RDBアプリに保存するか、XMLで保存するかの違いだけ。

フリーやオープンソースのBlog、掲示板のテンプレートを使えば、すぐに構築できますよ。

保存する時にXMLで保存し、呼び出すときにXSLTなどでフォーマットするだけの簡単な話ですよね。保存先がOracleや専用DBアプリに保存するか、XMLファイルとして、テキストで保存するかをシステム要件によって選択すればいい。

これって、XMLが唯一、祖先であるSGMLから引き継いだ、得意点。

XSLTなどのフォーマット定義ファイルさえちゃんと開発できれば、HTMLコーダーでも難なく構築できます。

しかし、ここてまてよ。とみんな考える。まず、ワードやエクセルなどにはXMLへの書き出し、Webページへの書き出し機能がある。それを使う手も当然ある。

それを使う意義だが、ワードなどのMS-OfficeにはVBAと言う自動化に適した、システムが存在する。それで構築しても、わざわざXMLにする意義があるのだろうか？

なんて言う疑問に突き当たる。

＞バイナリ形式のファイルではバージョン管理で前回のリビジョンとの差

これは上記の事を考えると、たいしたことではない。なにせ、XMLなどのテキストにしても、それを見るビューワーとか、どうするのですかね。

何のアプリで、何のバージョンなんて定義がつていまわる。それを回避するには独自ビューワーを作る事になり、時間が経つにつれ、何でそんな使いにくい物とか、時代遅れとか、面倒とか、後継者は、ぼやき、大論争になるでしょう。

私はなんども、そのような経験をしています。大きな企業になればなるほど、独自システムを持っているもんです。何せ、業務改善を遂行し、それだけを開発する部署が存在するので。

なので、あなたが考えているほど、ばら色ではないんですよ。

グローバルスタンダードに乗っかるほうが、コストや、メンテナンスは以外にも簡単なんですよ。

回答No.1

trajaa

そう言う文書の管理方法を変更する事に関して職場のコンセンサスは出来ているのでしょうか？

作成する担当者が異なると、文書の形式まで異なると言うのは宜しくないんでは無かろうか？

職場全体で文書管理方法を変えるので有れば、その職場でどんな方法が良いのか議論有るはずなのだろうが・・・

業界が変われば作法も変わる可能性があるだろうけど、仕様書の差分(変更点の詳細な内容)ってそれ程重要なのだろうか？

各版の仕様書を全て保管しておいて、版を更新する度にその版で更新した項目と更新した理由、必要なら更新ポイントの概略などを来歴管理として仕様書本体とは別に管理すれば充分事足りるモンだと思っているが。

結局何かモノを作るのでも、作ったモノを検査確認するのでも、最終的な仕様に添っているかどうかが大事なんじゃ無かろうか？

追伸
　ＭＳワードの場合、ツールメニューの中に変更履歴管理の機能がある。
　あんまり使いやすくは無いけど、一世代分ぐらいの変更履歴は見ることが出来る。

補足

回答ありがとうございます。

＞そう言う文書の管理方法を変更する事に関して職場のコンセンサスは出来ているのでしょうか？

具体案もなしでコンセンサスは取れないでしょう。
使うツールによって運用方法を変えるべき箇所があるかもしれないですし
ある程度アイデアを固めておいて、次に新規開発の案件やる機会があったら
そのときに提案してみようと思っています。

＞仕様書の差分(変更点の詳細な内容)ってそれ程重要なのだろうか？

重要度が高くないと可視化してはいけませんか？

＞各版の仕様書を全て保管しておいて、版を更新する度にその版で更新した項目と更新した理由、必要なら更新ポイントの概略などを来歴管理として仕様書本体とは別に管理すれば充分事足りるモンだと思っているが。

SVNとかで各版と修正コメントが記録されていればまあ、なんとでもなるとは思いますよ。
（コメントはアテにならない場合も多々ありますが。）

でも自分の直接の担当箇所ではないけど関連する箇所の修正とかがあれば
気になるしその部分について十分な説明を受けていない場合や、
その部分の担当者が信頼できない場合に設計書の修正差分を確認することはよくあります。

そういう時はテキストファイルを２つ用意してそれぞれに新版、旧版を
全選択⇒貼り付けして比較エディタで差分を確認するということを
よくやっているんですが、それをもっと自然というか気軽にできないかと考えています。

あとSVNとかでソースコードの最新分を取り込むときに前回との差分を確認したりする人は
少なくないとおもいますが、そういう気軽さ設計書についてもみんなが自分の作業範囲以外の
関連箇所にも目を光らせることができればいいんじゃないかと。

狙っているのは変更内容確認の効率化、相互チェックの強化、また作業者が
自分の作業範囲外の変更をよりきちんと把握することによる作業精度の向上あたりですかね。

＞結局何かモノを作るのでも、作ったモノを検査確認するのでも、最終的な仕様に添っているかどうかが大事なんじゃ無かろうか？

とても大事ですね。

＞追伸
＞　ＭＳワードの場合、ツールメニューの中に変更履歴管理の機能がある。
＞　あんまり使いやすくは無いけど、一世代分ぐらいの変更履歴は見ることが出来る。

貴重な情報をありがとうございます。これは知りませんでした。
しかし作業者が自分で履歴をつけなければいけない機能のようですね。
作業者の良心に依存する方法はできれば取りたくないと考えています。

履歴をつけるのをルール化すると作業に必要な工数は増えますし、
またあまりに面倒くさいとルールが守られないということも出てきます。
簡潔に文章化することが下手な人というのもたくさん居ますし、
また多くの人が守れる程度の面倒くささだとしても、
そのルールを守れない人の成果物ほどチェックの必要性が高いと思っていますので。