Como selecionar um escritor técnico
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Fase atual:
O programa "Temporada de documentos" de 2021 terminou em 14 de dezembro de 2021. Consulte
linha do tempo.
Esta página contém dicas para organizações de código aberto sobre como avaliar e
selecionar o redator técnico certo para a proposta de projeto do Google Season of Docs.
Introdução
As organizações de código aberto precisam contratar um redator técnico para trabalhar no projeto proposto. As organizações precisam ter um redator técnico.
Os redatores técnicos interessados em trabalhar com organizações participantes da Google Season of Docs podem ser encontrados no repositório do GitHub da Google Season of Docs e no canal#season-of-docs no Slack do Write the Docs.
Como avaliar um redator técnico
É recomendável solicitar exemplos de documentação desenvolvida anteriormente
dos redatores técnicos que você está considerando para se concentrar em
avaliar as habilidades e a experiência deles.
Habilidades e experiência em redação técnica
Examinar a experiência anterior do redator técnico.
O ideal é que o redator técnico tenha alguma experiência anterior na elaboração de documentação
técnica para a indústria de software. Uma das metas da Temporada de documentos do Google
é dar aos escritores técnicos a oportunidade de se envolver com
produtos voltados para desenvolvedores. Por esse motivo, não é essencial que o
escritor tenha experiência com APIs, SDKs ou outras plataformas de desenvolvedor, mesmo que
seu projeto se concentre em um público-alvo de desenvolvedores.
Concentre-se nas habilidades de linguagem e comunicação.
Avalie o trabalho anterior do redator técnico sob esse ponto de vista. O mais
importante: você consegue entender o que a pessoa escreveu? Se você quiser fazer uma
revisão detalhada da linguagem do trabalho do redator técnico, procure
consistência na pontuação e na fraseologia, ortografia correta e linguagem clara.
A frase é simples ou complicada? As frases são curtas ou se estendem
até ficarem difíceis de seguir?
Preste atenção ao design e ao layout do documento.
Confira o layout geral dos documentos de amostra. O design é lógico? Você
consegue encontrar facilmente o documento ou o conjunto de documentação? Há
duplicidade de conteúdo ou lacunas óbvias?
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-01-06 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-01-06 UTC."],[[["This documentation is specifically for the 2021 Season of Docs program, which concluded on December 14, 2021."],["Open source organizations participating in Google Season of Docs are responsible for finding and hiring their own technical writers."],["When assessing technical writers, prioritize their technical writing skills and experience by reviewing prior work samples, focusing on language clarity, communication skills, and document design."],["While prior experience in technical writing for software is ideal, it's not crucial for the writer to have specific experience with APIs, SDKs, or other developer platforms."],["Organizations can find potential technical writers through resources like the Google Season of Docs GitHub repository and the Write the Docs Slack channel."]]],["Open source organizations must hire a technical writer for their project, sourcing them independently. Potential writers can be found in the program's GitHub repo and Write the Docs Slack channel. Organizations should assess candidates' prior documentation, focusing on technical writing skills, language proficiency, and communication clarity. They should also examine document design, layout, and organization, looking for consistency, logical structure, and ease of navigation. Experience writing technical documentation is recommended.\n"]]
