Introdução

Conforme a Caplink evolui, a necessidade de criar uma documentação robusta que consegue ajudar a nós e nossos clientes se torna cada vez mais relevante.

Ferramentas

Utilizaremos as seguintes ferramentas para criar e mostrar a documentação completa da Caplink:

  • Ferramentas - Obsidian como ferramenta oficial para criar e editar a documentação
  • Ferramentas - Quartz como framework de geração de páginas estáticas em formato “Wiki”
  • Ferramentas - Git como controle de versão da documentação e mecanismo de deployment das atualizações realizadas
  • sjdofdsjo

Formatos

Sugerimos os seguintes formatos de documentação para cada caso de uso