Sobre o serviço
TraduzidoEu escrevo documentação técnica e ajuda de produto que as pessoas realmente leem: um guia do usuário, um centro de ajuda, uma referência de API. O trabalho começa desmontando o produto. Eu passo por ele como um novato, anoto cada lugar onde fiquei preso e coleto as tarefas reais que seus usuários trazem. A estrutura cresce a partir dessas tarefas, não da sua árvore de menu: primeiro o lançamento e a primeira pequena vitória, depois o trabalho cotidiano, e só depois os cenários complexos que poucas pessoas precisam, mas que consomem a maior parte do tempo da equipe de suporte.
Cada artigo é um conjunto de etapas com capturas de tela, legendadas para que o leitor nunca precise adivinhar qual botão é o certo. Uma seção separada cobre erros comuns e o que fazer sobre eles: o texto na tela, a razão por trás disso, a saída. A parte da API traz exemplos de solicitações e respostas para cada método, explica campos e códigos de status, e diz claramente o que acontece em caso de falha. Um glossário mantém os termos do produto em um só lugar, para que a interface, a ajuda e as respostas de suporte usem as mesmas palavras, e um breve guia de estilo fixa o tom e a redação, para que o texto mantenha uma única voz, mesmo quando outras pessoas adicionam a ele mais tarde.
Cada instrução é verificada ao percorrer as etapas no produto ao vivo; nada escrito da memória de um desenvolvedor, sem essa verificação, vai para a ajuda. Chaves, tokens e credenciais de teste em exemplos são substituídos por marcadores. A documentação para um recurso inacabado é marcada como um rascunho e nunca é apresentada como pronta.
— walkthrough do produto e uma lista das tarefas reais do usuário
— estrutura de ajuda desde o primeiro lançamento até cenários avançados
— instruções passo a passo com capturas de tela e legendas
— uma seção sobre erros comuns e o que fazer sobre eles
— referência de API com exemplos de solicitações e respostas
— glossário de termos mais um breve guia de estilo e tom
— cada instrução re-verificada no produto ao vivo
— fontes entregues em um formato que é fácil de editar mais adiante
Cada artigo é um conjunto de etapas com capturas de tela, legendadas para que o leitor nunca precise adivinhar qual botão é o certo. Uma seção separada cobre erros comuns e o que fazer sobre eles: o texto na tela, a razão por trás disso, a saída. A parte da API traz exemplos de solicitações e respostas para cada método, explica campos e códigos de status, e diz claramente o que acontece em caso de falha. Um glossário mantém os termos do produto em um só lugar, para que a interface, a ajuda e as respostas de suporte usem as mesmas palavras, e um breve guia de estilo fixa o tom e a redação, para que o texto mantenha uma única voz, mesmo quando outras pessoas adicionam a ele mais tarde.
Cada instrução é verificada ao percorrer as etapas no produto ao vivo; nada escrito da memória de um desenvolvedor, sem essa verificação, vai para a ajuda. Chaves, tokens e credenciais de teste em exemplos são substituídos por marcadores. A documentação para um recurso inacabado é marcada como um rascunho e nunca é apresentada como pronta.
— walkthrough do produto e uma lista das tarefas reais do usuário
— estrutura de ajuda desde o primeiro lançamento até cenários avançados
— instruções passo a passo com capturas de tela e legendas
— uma seção sobre erros comuns e o que fazer sobre eles
— referência de API com exemplos de solicitações e respostas
— glossário de termos mais um breve guia de estilo e tom
— cada instrução re-verificada no produto ao vivo
— fontes entregues em um formato que é fácil de editar mais adiante
