0

異なる企業の異なるシステム間のインターフェース記述としてプロトコルを開発する必要があります。実装は、各企業の開発者によって異なる言語 (不明) で行われます。

ただし、テキスト記述ベースのプロトコルを一緒に開発したいと考えています。私は現在のバージョンのベース コピーを持っているので、コメントを求めて全員に送信したいと考えています。

そうするための良いツールは何ですか？

現在、MS Word を使用しているため、いくつかの問題が発生しています。

  • テキストの書式設定には多くの時間が必要です。
  • メソッドの説明でデータ型を参照することはできません。
  • 言葉遣いは章ごとに異なり (異なる著者)、一致させるのが困難です。

パーフェクトは次のとおりです。

  • 用語集とオートコンプリートを備えたツール。
  • アクティブなリンクを持つ他の項目 (メソッド、データ型など) への参照。
  • 人間が読める (PDF) ドキュメントの自動生成。

そのようなツールを知っていますか？

PS: 私は、Sparx Systems Enterprise Architect に仕事をしてもらいませんでした。これもヒントになるかも？

4

1 に答える 1

1

これは非常に大きな問題です。プロトコル仕様で文書化したい (すべき) 可能性のある側面がたくさんあるからです。最も重要なものは、データ構造とメッセージ シーケンスの 2 つです。次に、エラー管理、認証、タイミングなどがあります。

UML は確かにこれらのことを記述するために使用でき、Enterprise Architect はモデルから多目的なドキュメントを生成することができます。しかし、最初に、プロトコルの各側面をどのようにモデル化するかを非常に厳密に決定する必要があり、そこから必要な EA 構成/適応を構築する必要があります。

EA から高品質のドキュメントを取得するには、オブジェクト モデルの DocumentGenerator クラスを使用してアドインからドキュメントを生成することをお勧めします。これにより、従来の RTF ジェネレーターよりも柔軟性が高くなります。たとえば、Word の API に加えてアクセスできます。したがって、EA の API を単独で使用した場合よりもはるかに多くのことをドキュメントで行うことができます。

プロトコルのサイズや複雑さを知らなくても、EA の適応を書いた経験のある人にとっては、少なくとも数週間の作業が必要になると思います。ただし、プロジェクトの範囲が複数の企業が関与するようなものである場合は、投資する価値がある可能性があります。

于 2013-10-14T20:32:49.070 に答える