CODEWITHSUNDEEP
javascriptenterprise-architectdocumentation-generation
sarin
sarin

Reputation: 5307

Javascript code driven documentation to Enterprise Architect

Our team develops on AngularJS, node.js and mySql\Oracle. As part of our application documentation our organisation wants us to capture our User Stories/Use Cases in Enterprise Architect and then have it generate sequence diagrams of interactions. At the moment this is a manual process and every time the application changes, the documentation has to manually change. This is time and resource intensive.

Are there any js tools or EA plugins that allow developers to comment their code as they write which can then generate as part of the build process some sort of .json/.xml/.xmi/.yaml file which effectively has an EA model in and can then be imported into Enterprise Architect ? This is in a similar way to tools like Swagger but instead of generating html it generates an EA model in a file. The goal I would imagine is to generate a list of user stories or use cases, with Actors, acceptance criteria, exceptions, test cases etc

Upvotes: 1

Views: 505

Answers (1)

Booster2ooo
Booster2ooo

Reputation: 1447

I must admit I don't know anything about EA but, as a more generic answer, I'd advice you to have a look at JSDoc. It allows you to build documentation based on comments:

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

Upvotes: 2

Related Questions