A qualidade tem sido uma das principais preocupações das empresas.
Os produtos não competem apenas em preço ou se estão disponíveis quando e onde for necessário, mas também pela qualidade do que eles oferecem.
As características de qualidade de informações técnicas devem refletir o que os usuários esperam e querem a partir da informação e agregam qualidade ao produto ao qual se destinam.
Algumas qualidades que são observadas numa boa documentação técnica são:
Qualidade | Descrição |
|---|---|
| Conciso | Breve e sucinto; Falando muito com poucas palavras. |
| Consistente | Usando o mesmo elemento ou conteúdo onde apropriado; Acordando ou tendo coerência lógica entre as partes. |
| Precisão | Expressões claras; Declarações com um alto nível de correção. |
| Legibilidade | Leitura com palavras e sentenças fáceis, usando termos técnicos somente se forem necessários ou apropriados. |
| Relevância | Adequação ao assunto. |
| Simplicidade | Livre de complexidade. |
| Adequação | Apenas informação suficiente. |
| Correção | Livre de erros e enganos. |
| Honestidade | Veracidade, livre de fraude e engano. |
| Utilidade | Capacidade de ser utilizado com vantagem ou prestação de serviço. |
Com base nas qualidades acima podemos afirmar que uma documentação técnica de qualidade deve estar em conformidade com as características abaixo para que a mesma tenha qualidade:
Fácil de usar | |
|---|---|
| Orientado a tarefa | Foco em ajudar os usuários a realizar suas tarefas que são associadas ao sistema/ferramenta em relação ao seu trabalho. |
| Acurácia | Livre de erros; aderentes a fatos e verdades. |
| Completa | Contêm todas as partes necessárias, e somente estas. |
Fácil de entender | |
|---|---|
| Clara | Livre de ambiguidades. Apresentar a informação de maneira que os usuário entendam ao ler pela primeira vez. |
| Concreta | Incluir exemplos apropriados, cenários, analogias, gráficos e linguagem especifica. |
| Utilização adequada das convenções de escrita, palavras e frases. | |
Fácil de localizar | |
|---|---|
| Organização | Arrumação coerente das partes, que façam sentido para o usuário. |
| Recuperável | Organização da informação de forma que possibilite ao usuário a localizar um item especifico de forma fácil e rápida. |
| Eficácia Visual | Atratividade e significado maior de informações por meio do uso de layouts, ilustrações, ícones, cor e outros dispositivos gráficos. |