Enterprise ArchitectへのJavascriptコード駆動ドキュメント

Question

私たちのチームは、AngularJS、node.js、およびmySql \ Oracleで開発しています。アプリケーションのドキュメントの一部として、組織では、エンタープライズアーキテクトでユーザーストーリー/ユースケースを取得してから、相互作用のシーケンス図を生成する必要があります。現時点では、これは手動プロセスであり、アプリケーションが変更されるたびにマニュアルが手動で変更されなければなりません。これは時間とリソースを大量に消費します。

開発者が書き込み時にコードにコメントを付けることができるjsツールやEAプラグインはありますか。ビルドプロセスの一環として、.json/.xml/.xmi/.yamlファイルがあります。 EAモデルをインポートしてEnterprise Architectにインポートできますか？これはSwaggerのようなツールと同様の方法ですが、htmlを生成する代わりにファイル内にEAモデルを生成します。私が想像するゴールは、アクター、受諾基準、例外、テストケースなどを含むユーザーストーリーまたはユースケースのリストを生成することです。

Answer 1

私はEAについては何も知らないが、私はあなたにJSDocを見てほしいと助言したいと思います。コメントに基づいてドキュメントを作成することができます。

/** 
* Represents a book. 
* @constructor 
* @param {string} title - The title of the book. 
* @param {string} author - The author of the book. 
*/ 
function Book(title, author) { 
}