Geração de Documentos de Arquitetura de Software
Versão do documento: 1.0, 01/05/2018
Introdução
Objetivo do Documento
O objetivo deste documento é apresentar como gerar Documento de Arquitetura de Software no padrão Basis.
Referências
-
Asciidoctor: Ferramenta que permite a geração de documentos em vários formatos (PDF, HTML, EPub, DocBook) a partir de arquivos no formato texto com marcações.
-
PlantUML: Ferramenta que permite a geração de diagramas UML a partir de arquivos no formato texto com uma linguagem específica.
Execução da Geração do Documento
Ferramentas utilizadas
Para editar o documento é necessário o uso de IntelliJ Community ou Visual Studio Code, os dois possuem plugins para edição de arquivos no formato asciidoc ou plantuml.
Instalação do Gerador
Antes de iniciar, é necessário configurar o npm para utilizar o registry privado da Basis. Para isso, crie o arquivo .npmrc na raiz do projeto e adicione:
registry=http://element.basis.com.br/repository/npm-registry/
O registry interno também atua como proxy do registry oficial, dispensando o seu uso. É recomendado que o arquivo seja versionado após o procedimento.
Em seguida, execute o comando npm login. Será necessário fornecer o nome do usuário, a senha e o email da Basis, para que o npm consiga autenticar no registry privado.
Para terminar instalar o gerador de maneira global com o comando: npm install -g generator-das.
Geração do Documento
Para gerar um DAS, na pasta 4 - Análise e Design/DAS_CODIGO_FONTE do repositório de documentação do projeto, executar o comando: yo das. Em seguida responder às perguntas do gerador, como Nome do Cliente, Nome e Sigla do Projeto…
No final da geração será criado um projeto Maven configurado para geração da versão PDF.
O Documento de Arquitetura no formato AsciiDoc se encontra no caminho: src/main/asciidoc/documento-arquitetura.adoc.
Para gerar o DAS no formato PDF, basta executar o seguinte comando na raíz do projeto (onde se encontra o arquivo pom.xml): mvn clean generate-resources