Pular para o conteúdo

Documentação

Documentação

Esta seção reúne o conhecimento técnico do TECER para quem quer entender as tecnologias testadas, repetir um procedimento ou consultar um dado exato. Os diários de projeto contam o que aconteceu e o que aprendemos; a documentação guarda o que é preciso para que outras organizações possam reproduzir ou adaptar o trabalho.

A documentação segue o modelo Diátaxis, que organiza os textos de acordo com a necessidade de quem consulta. Os termos técnicos estão explicados no glossário.

Como navegar

Explicações

As Explicações respondem ao porquê: como uma tecnologia funciona, por que o projeto fez certas escolhas e o que os testes revelaram. São o melhor ponto de partida para quem chega de um diário de projeto.

Como fazer

Os guias Como fazer descrevem tarefas específicas, passo a passo, para quem já conhece o básico e precisa realizar algo concreto, como montar uma bancada de testes ou medir a perda de um cabo.

Referências

As Referências apresentam, em linguagem simples, cada equipamento e programa usado: o que é, como apareceu no projeto e onde está a documentação do fabricante.

Tutoriais

Os tutoriais, que ensinam uma tecnologia do zero por meio da prática, estão em preparação.

Por onde começar

  • Para entender uma tecnologia: comece pelas Explicações.
  • Para realizar uma tarefa: vá para Como fazer.
  • Para consultar um dado técnico: use as Referências.
Última atualização em