Escolar Documentos
Profissional Documentos
Cultura Documentos
Nota:
UC: Modelagem Virtual de Elementos Mecânicos - CAD
- Objetivos:
O principal objetivo da Documentação técnica é ajudar os usuários a alcançar os
seus objetivos usando um produto. Isto só é possível através de uma
documentação clara e de fácil interpretação. É por isso que existem vários tipos
de documentação. Se você é um novato ou experiente Documentação técnica,
você deveria conhecer os tipos mais populares de documentação porque cada
tipo de documento implica em diferentes conteúdos, estilos e assim por diante.
- Princípios:
1 – O princípio 1 diz que devemos escrever sob o ponto de vista do leitor.
Determinar quem são os leitores. Determinar o que os leitores querem saber.
Tornar as informações fáceis de serem encontradas.
2 – Evitar repetição desnecessária.
3 – Evitar ambiguidade.
4 – Usar um template de documento.
5 – Documentar a razão para as decisões tomadas.
6 – Manter a documentação atualizada, mas não atualizada demais.
7 – Revisar a documentação criada.
- Métodos: