重複保守 - コードと文書

Question

これは最善のタイトルではないかもしれません - 私の問題を読んだ後に誰かがより良いものを思い付くなら、私は感謝します。また、私は主にインターネットで独学で教えていると言いたいので、私が気づいていないツールがたくさんあるかもしれません。

私は、JavaとC＃の両方でフローベースプログラミング（FBP）の概念を実装するソフトウェアを維持しています。これらのそれぞれについて、私は上のコードがあります

• 私のウェブサイト
• SourceForgeのファイルリリースシステム（zipファイルまたはjarファイル）
• SourceForgeのSVN
また

を、私はバージョンの参照を持っていますそして上の（時には部分）説明：

• 私のウェブサイト（HTML）
• 私ウィキ
• のJavadoc

は、描画ツールは、FBPコードのJavaバージョンの最新バージョンについて知る必要があること、また、私のウェブサイトやSourceForgeでもあります。

すべてがかなり徹底的にクロスリンクされていますが、時には私はリファレンスを見逃しています！数日前、私は長い間プロジェクトのためにSourceForge Newsを更新していないことに気づいたので、私はそれを慌ててやる必要がありました:-)

私はこれらの車両のいくつかはおそらく冗長ですが、一般的に、私は誰が何を見ているのか分かりません。

私の質問は、このすべてのオーバーヘッドを減らす方法があるかどうかです。 HTMLの "imbed"関数がうまくいくので、少なくとも最新のバージョン番号を1か所に格納することができます。私はおそらくJavaの相互参照を簡素化することができますが、インター言語はさらに良いかもしれませんが、そうは思わないでしょう。

アイデアを歓迎します。

Answer 1

ビルド/展開プロセスの一環としてドキュメントを更新して管理したいと思うようです。

1. ビルド
2. ユニットテストなど
3. コンパイルドキュメント
4. 展開はそうあなたが常にあなたのしっぽを追いかけことになるだろう
5. デプロイコンパイルドキュメント

を構築します。明らかにドキュメントの展開には、どこに行くのか（例えば、あなたのウェブサイトにコピーしたり、他の場所にFTPしたなど）に異なる解決策が必要になるでしょう。

私はこのすべてのための万能薬があるのか​​分かりません。私はプロパティファイル/設定ファイルにバージョン番号を保持し、適切な検索/置換を行います。可能な限りコード・ドキュメンテーションはコード自体に入り、それが私のビルドで前処理されています（上記のステップ3）。

あなたが見ましたか？Doxygen？それはあなたの多言語の要件を処理し、ドキュメントの構築/保守のために十分に確立されています。

Answer 2

ビルド/公開プロセスを自動化する必要があるようです。 O'Reillyのthis articleをもう一度読み返しています。どちらも同じような状況になっているようですね。彼のソリューションはPythonを多用していますが、少なくともあなたにはいくつかのアイデアが与えられます。