他のドキュメントの内容を取り込む「参照」機能

投稿日:2008年08月12日 作成者:yasunaka

ドキュメントを作る際、そのほとんどはコピーして作って、ある部分だけ書き換えて新しいものを作る、そんなケースって結構ありませんか? この場合に問題なのは、作ってしまった後のメンテナンスです。共通部分の変更の場合、コピーしたドキュメントの数だけメンテナンスしなければならず、大変です。

次のcrossnoteのリリースではそんな場合に有効な「参照」機能が追加になります。ドキュメントをコピー&貼り付けする際、「参照として貼り付ける」ことで、そこに表示される内容は、オリジナルのドキュメントの中身と同一のものになります。つまりオリジナルのドキュメントを修正すると、それを参照しているドキュメントも自動的に修正されるようになります。

参照している部分は編集ができなくなっているのですが、編集できる状態にして内容を書き換えることもできます。ただし書き換えてしまった場合には、オリジナルのドキュメントを修正しても、自動的には変更されなくなります。この場合でも参照リンク情報は保持されており、修正を取り消して元の状態に戻すことも可能です。

参照はcrossnoteのドキュメント内の枠の単位で可能です。従って図や表、文章などを枠の単位で部品化して、さまざまなドキュメントで再利用し、かつ保守性を高めることができます。

ある方にこの機能をご紹介したら、「ドキュメンテーションもプログラミングと同じになってきた」とおっしゃっていました。うまい表現だと思います。Eclipseでプログラムを書くように、crossnoteでドキュメントを書く時代がもうすぐやってきます。

この機能のリリースはまだ確定していませんが、今月中には行う予定です。お楽しみに。