Saltar para o conteúdo
BigTree108

Serviços de redação técnica

Serviços de redação técnica para empresas de software: referências de API, guias para programadores, documentação para utilizadores, runbooks e notas de versão, escritos como código a par do produto e mantidos atualizados a cada versão.

O que fazem os nossos redatores técnicos

  • Documentação de APIs

    Referência gerada a partir do seu esquema OpenAPI ou GraphQL, com guias de início rápido, demonstrações de autenticação e exemplos executáveis escritos à volta, para que a referência nunca seja editada à mão.

  • Docs as code

    Documentação em Markdown no seu repositório, revista em pull requests como código e publicada com Docusaurus, Starlight ou um gerador semelhante pelo mesmo pipeline do produto.

  • Guias de utilizador e centros de ajuda

    Guias orientados a tarefas e artigos de centro de ajuda organizados pelo que o leitor está a tentar fazer, divididos em tutoriais, guias práticos, referência e explicação segundo o framework Diátaxis.

  • Runbooks e guias de operações

    Procedimentos passo a passo para deployments, restauros, resposta a incidentes e prevenção, testados por alguém que não os escreveu.

  • Notas de versão e changelogs

    Notas de versão que dizem aos utilizadores o que mudou para eles, e changelogs para integradores, redigidos a partir dos pull requests integrados e verificados face à versão.

  • Verificações de estilo e qualidade

    Um guia de estilo e uma lista de terminologia aplicados pelo Vale no pipeline, com verificação de ligações quebradas em cada build, para que a coerência não dependa de um único revisor.

Contratar redatores técnicos

  • A tempo inteiro na sua equipa

    Redatores técnicos que trabalham no seu horário, nas suas ferramentas e reuniões, e reportam ao seu responsável, com o contrato ucraniano, o processamento salarial e as férias do nosso lado.

  • A tempo parcial ou fracionado

    Redatores técnicos durante um número fixo de dias por semana, quando o trabalho é real, mas ainda não justifica uma função a tempo inteiro.

  • Para um projeto ou um lançamento

    Redatores técnicos para um período de trabalho definido, desde a primeira semana até à entrega, com a data de fim acordada à partida.

A página da equipa dedicada explica como os especialistas integram a sua equipa, e a página de outsourcing aborda a entrega de projetos, as tomadas a cargo e a forma como cobramos.

Com quem trabalham os nossos redatores técnicos

  • Engenheiros e responsáveis técnicos

    Entrevistas, revisões e rigor técnico

  • Product managers

    Funcionalidades, públicos e âmbito de cada release

  • Engenheiros de suporte

    As perguntas que os utilizadores realmente colocam

  • Designers de UI e UX

    Textos de interface e diagramas

Como trabalham os nossos redatores técnicos

A documentação vive onde vive o código: no repositório, revista no mesmo pull request da alteração que descreve, e compilada e publicada pelo pipeline. Uma funcionalidade só está concluída quando a sua documentação foi integrada, o que mantém a documentação tão atual como o código.

A escrita parte do leitor: quem é, o que pretende fazer e o que já sabe. Os tickets de suporte e os termos de pesquisa mostram onde a documentação atual falha, e essas páginas são corrigidas em primeiro lugar.

Outras funções que disponibilizamos

Visão geral de Funções na equipa

Perguntas sobre a contratação de redatores técnicos

Um redator técnico consegue documentar um sistema que ninguém documentou?

Sim. O redator lê o código e a configuração, entrevista os engenheiros e produz uma visão geral da arquitetura, runbooks e um glossário, revistos por quem opera o sistema. É o mesmo primeiro passo, só de leitura, com que começam as nossas tomadas a cargo de sistemas herdados.

Como mantêm a documentação da API alinhada com a API?

A referência é gerada a partir do esquema OpenAPI ou GraphQL na build, pelo que não pode divergir da API. O redator acrescenta o que um gerador não consegue: o guia de introdução, o passo a passo da autenticação e os exemplos de que um programador precisa antes de a referência ser útil.

Em quanto tempo podem começar redatores técnicos?

Quando o redator técnico adequado está disponível, o arranque depende apenas da sua entrevista, do NDA e da cedência de propriedade intelectual. Caso contrário, fazemos uma pesquisa, que normalmente produz perfis de candidatos em duas a três semanas, e ninguém começa antes de a sua empresa dar o seu acordo.

Como contratamos redatores técnicos através da BigTree108?

Diga-nos qual é o trabalho, a senioridade e o horário de que precisa. Propomos uma ou duas pessoas com os respetivos perfis, a sua empresa entrevista-as como entrevistaria uma contratação própria, e assina um único contrato com a BIG TREE 108 LLC e recebe uma fatura por mês.

A quem pertence o trabalho que produzem?

A sua empresa. Cada especialista tem um contrato assinado com a BigTree108 que atribui à empresa todo o trabalho produzido, e o nosso contrato com a sua empresa atribui-lho. O código, os designs e os documentos são entregues nos seus próprios repositórios e ferramentas, e não mantidos onde só nós os podemos alterar.

A documentação está atrasada em relação ao produto?

Diga-nos qual é o produto, quem o lê e onde se encontra atualmente a documentação. Recebe resposta no prazo de um dia útil: perfis de candidatos ou um plano de documentação.

Enviar e-mail para hello@bigtree108.comComo respondemos