Документация на основе кода Javascript для Enterprise Architect

Question

Наша команда разрабатывает на AngularJS, node.js и mySql\Oracle. Как часть нашей прикладной документации, наша организация хочет, чтобы мы собрали наши пользовательские истории / варианты использования в Enterprise Architect, а затем сгенерировали диаграммы последовательности взаимодействий. На данный момент это ручной процесс, и при каждом изменении приложения документация должна меняться вручную. Это требует много времени и ресурсов.

Существуют ли какие-либо инструменты js или плагины EA, которые позволяют разработчикам комментировать свой код во время написания кода, который затем может генерировать как часть процесса сборки какой-то файл.json /.xml /.xmi /.yaml, который по сути имеет модель EA в а потом можно импортировать в Enterprise Architect? Это похоже на инструменты вроде Swagger, но вместо генерации html генерирует модель советника в файле. Цель, которую я хотел бы представить, состоит в том, чтобы создать список пользовательских историй или вариантов использования, с актерами, критериями приемлемости, исключениями, тестовыми примерами и т. Д.

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) {
}