Criação e Publicação da Documentação do BrERP
Este documento detalha os procedimentos para criar, modificar e publicar a documentação do sistema BrERP, tanto manualmente quanto automaticamente.
Documentação Manual
Esta seção aborda como configurar seu ambiente local para criar e editar a documentação.
Pré-Requisitos
Para contribuir com a documentação, é necessário ter os seguintes programas instalados em sua máquina:
-
Node.js (via NVM): Gerenciador de versões do Node.js, essencial para executar o ambiente de desenvolvimento do Docusaurus.
- Windows:
- Linux:
-
Git: Sistema de controle de versão utilizado para gerenciar as alterações.
Ao instalar o Git, configure suas credenciais de usuário. Para garantir a correta autoria dos commits, utilize a imagem de exemplo abaixo como referência de configuração.
-
Editor de Código: Recomendamos o uso do Visual Studio Code por sua integração com Git e suporte a Markdown.
Obtendo e Atualizando Repositório da Documentação
O repositório documentacao
é o projeto principal com a engine do Docusaurus e todo o conteúdo da documentação. O material criado/alterado deve ser enviado para a branch main
, que será automaticamente validada e transportada para a branch gh-pages
, sendo onde fica a versão pública.
- Abra o terminal;
- Navegue até o diretório onde deseja armazenar o projeto;
- Clone o repositório da documentação com o comando:
git clone git@github.com:devcoffee/documentacao.git
- Se você já possui o repositório clonado, certifique-se de que ele está atualizado antes de iniciar o trabalho:
git pull
Estrutura de Pastas
Documentações
Na pasta raiz da Documentação encontra-se o diretório docs
, que contém toda a documentação do projeto, organizada nas seguintes subpastas:
documentacao
└── docs
├── dev-guides
├── legal-stuff
├── release-notes
├── system-manual
│ └── brerp
│ └── new-features
└── user-guides
system-manual
: Armazena os manuais do sistema gerados automaticamente (brerp
) e as documentações das funcionalidades lançadas (new-features
).dev-guides
: os guias para desenvolvedores estão diretamente na pasta.user-guides
: os guias para usuários são organizados em subpastas temáticas.
documentacao/docs$ tree user-guides -L 1 -d
user-guides
├── AdministracaoSistema
├── AvaliacaoDesempenho
├── CRMeCall
├── Devolucao
├── GestaoAtivos
├── GestaoCobrancas
├── GestaoCompras