Se você foi encarregado de escrever um documento que deveria instruir outra pessoa a fazer algo, a maneira atual de fazê-lo mais ou menos joga os métodos antigos pela janela.
1. Cabeçalhos bombásticos grandes
Você notará que os cabeçalhos no PCMech, como o logo acima desta frase, são enormes. Isso ocorre porque é mais fácil ver, ler e saber onde você está no documento.
2. Menos Palavras
Caminho errado:
A documentação a seguir explica como usar e operar o Fanny Whacker 2000.
Caminho certo:
Instruções sobre como usar o Fanny Whacker 2000
Lembre-se sempre desta frase ao escrever a documentação: Chegue ao ponto o mais rápido possível.
3. Ignore referências inúteis
Se a referência não tem nada a ver com as instruções principais do que você está tentando descrever, como:
Para mais informações sobre o Turnip Twaddler de Fanny Whacker 2000, consulte o documento FU, subseção ID10T.
… não faça isso.
4. Data. Sempre.
A data em que a documentação foi escrita deve estar na área do rodapé de todas as páginas. Se for um documento eletrônico, a data será exibida duas vezes. Uma vez no começo, uma vez no final.
Você pode escrever isso como "Última revisão (inserir data aqui)".
5. Os avisos sempre devem ser publicados antes do ponto sem retorno
Se houver algo em sua documentação que possa danificar / destruir / obliterar algo, se executado incorretamente, essas informações devem ser colocadas diretamente após as instruções, estar à vista (ou seja, na mesma página) e acentuadas.
Exemplo:
Etapa 5. Limpando o Fanny Whacker 2000
As pás do FW2000 devem ser limpas suavemente usando um pano macio não abrasivo.
AVISO: Use apenas solvente sem amônia para evitar que o FW2000 exploda e cause sua morte prematura.
Em uma nota final, uma boa documentação não é de ser super-descritiva sobre todas as coisas possíveis imagináveis. Leia sua documentação e pergunte a si mesmo, ele instrui corretamente? Se a resposta for sim, a próxima pergunta é: ela instrui rapidamente ? Se sim, a documentação está boa.
