trabalho de um redator técnico é dedicado aos meus redatores técnicos russos favoritos - para criar documentos para produtos de software, basicamente todos os tipos de manuais do usuário. Desenvolver um documento não é fácil. Existem muitas abordagens e práticas. Por exemplo, escritores técnicos em empresas científicas e industriais geralmente escrevem de acordo com GOSTs ou outros padrões domésticos. Seu objetivo é descrever o produto de forma precisa e correta. E redatores técnicos em empresas internacionais escrevem de acordo com guias de estilo (Manual de Estilo da Microsoft, por exemplo). Nesse caso, o objetivo é antes transmitir ao usuário como o produto funciona. Aqui, o foco muda do produto para o leitor.
Já escrevi tecnologia em diferentes lugares, com diferentes regras e políticas. Olhando para trás, posso dizer que mesmo em institutos de pesquisa, os textos podem ser reorientados para o usuário final e os documentos serão beneficiados com isso. Mas eles não escrevem sobre isso em GOSTs. E os guias de estilo, em primeiro lugar, são em inglês e, em segundo lugar, não são anunciados em escritórios nacionais como NPP, KB, etc. Portanto, há uma clara falta de informação. Vou tentar preencher.
Como as docas para produtos Yandex, Google, Microsoft e Apple diferem da documentação tradicional criada por engenheiros de design?
Um engenheiro clássico escreve de forma que o produto seja descrito da forma mais completa e correta possível + de acordo com GOSTs e terminologia aceita. Além disso, muitos termos e definições em GOSTs estão desatualizados e não colorem os documentos. Mas isso não é um problema para os construtores - ninguém realmente pensa se o texto é de fácil compreensão para o usuário. Mas os docks feitos para pessoas são diferentes: eles são escritos em uma linguagem compreensível e levam em consideração os interesses do usuário. Uma questão de prioridades.
Essas prioridades e objetivos do autor influenciam muito os documentos obtidos. Vamos ver com exemplos como fica na vida real:
| Abordagem de design | Orientado ao usuário
|
|
|---|---|---|
| Simplicidade de termos
|
Clique no ícone da pasta com o clique do mouse do LMB.
|
.
|
|
|
20- , , . .
|
, , . |
|
|
. «». , . «».
|
. |
| , . . , , .
|
, . , .
|
|
|
|
. – , .
|
: , , .. , .
|
|
|
: , , , , .
|
, . , . , , .
– . – . , . |
Acontece que você olha os documentos e eles já estão desatualizados. É como ler as instruções de um trator dos anos 1950. Precisamos torná-los mais relevantes, mas parece impossível. Na verdade, tudo é possível. Nos artigos a seguir, analisarei passo a passo como exatamente passar de um enorme conjunto desatualizado de documentação para docas leves, compreensíveis e modernas. Analisaremos cada um dos pontos da tabela em um artigo separado.
Spoiler
Não vai ser fácil.