Conceito
Informações técnicas são informações sobre um assunto técnico, geralmente para um determinado público e para um determinado fim.
Essas informações devem ser práticas e não para fins de venda do produto, porque, em geral, o usuário têm pouco tempo para encontrar a informação que eles precisam e não é uma leitura de lazer, mas sim uma necessidade de saber algo para resolver um problema, provavelmente como parte de ser trabalho...
A leitura da informação técnica tem reputação de ser a última coisa que as pessoas querem ler ou a última coisa a recorrer para pedir ajuda, pois são leituras chatas, incompreensíveis, inutilizáveis e impossíveis de encontrar. Com isso, os escritores técnicos devem tornar a informação mais fácil de usar, de entender e encontrar e esse guia tem como objetivo ajudá-lo nessa tarefa..
Objetivo do Guia de Estilo de Publicações Técnicas
Os principais objetivos do guia são:
- Melhorar a qualidade das publicações técnicas, consequentemente, melhorar a qualidade dos sistemas para os usuários.
- Criar publicações técnicas em conformidade com normas e padrões internacionais.
- Definir as boas práticas e padrões dos documentos e manuais técnicos.
- Melhorar a percepção da marca Alterdata pelos nossos usuários.
O guia contempla boas práticas e padrões para as novos manuais ou documentações ou inclusão de novos itens nos manuais ou documentações já existentes.
Os manuais e documentações criados antes da publicação deverão ser compatibilizadas de acordo com o planejamento e definição da gerência de cada setor.
Publicações Técnicas
As publicações técnicas que se aplicam esse guia são:
Nome | Descrição |
|---|---|
Destaques e novidades da versão dos produtos. | Documentação suplementar disponibilizada para os clientes, nas liberações de versões, com a listagem de erros ou melhorias realizadas naquela versão do produto. |
| Manuais (helps) dos produtos | Manuais (help) de ajuda dos produtos. |
| Documentos complementares | Qualquer documentação complementar criada e mantida pelos escritores técnicos, como primeiros passos e etc. |
Os materiais para clientes internos e vídeos para clientes externos são de responsabilidade do setor da UCA.
Bibliografia
Sun Microsystems, Inc., Read Me First!: A Style Guide for the Computer Industry, Third Edition. Santa Clara, CA: Sun Technical Publications, 2009.
Microsoft. Manual of Style. Fourth Edition. Redmon, Washington: Microsoft Press, 2012.
HARGIS, Gretchen et al. Developing Quality Technical INformation: A Handbook for Writers and Editors. Second Edition. Upper Saddle River, New Jersey: Prentice Hall, 2004.
PRINGLE, Alan S.; O'KEEFE, Sarah S. Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content. 3rd Edition. Research Triangle Park, NC: Scriptorium Publishing Services, Inc.,2009.
LAAN, Kista Van, The Insider's Guide to Technical Writing. First edition. Laguna Hills, CA: XML Press, 2012.