Home
Objetivo
Visando a melhoria continua do time, esta plataforma foi desenvolvida com o objetico de reunir em um só lugar as documentações internas, evitando disperdicio de tempo em procurar documentações enviadas em e-mails, Google Drive, etc.
Esta plataforma é um framework do facebook para documentações chamado Docusaurus, e o seu padrão de documentações são em Markdown.
Acesse: Guia básico de Markdown
Como publicar minha documentação?
Encaminhe um e-mail para os responsáveis pelo ambiente, com o seu arquivo.md, e todas as imagens utilizadas dentro do arquivo.
Informe no corpo do e-mail qual será a o caminho da barra de menu em que a documentação será inserida Ex:
Para cada documentação, crie um diretório com o nome da documentação ex: primeirodoc.
Dentro deste diretório, crie o arquivo.md e a pasta img caso possua imagens na documentação. Na inserção das imagens das imagens garanta que o caminho esteja como img/minhafoto.png
Exemplo:
Caso queria prefira hospedar suas imagens, recomendo a utilização da plataforma Imagekit.io