Sobre este modelo
O modelo Documentação Tech é uma carta de apresentação disposta como uma página de documentação técnica — sumário em rail esquerdo, corpo à esquerda em Inter, caixas tipo código em JetBrains Mono e rodapé estilo doc com tag de versão. O formato reflete diretamente o ofício: a carta lê-se como uma página Mintlify, ReadMe ou Docusaurus. Compatível com os ATS modernos (Greenhouse, Lever, Ashby); o rail sumário é puramente visual.
Para que perfil?
Encaixa com technical writers (Associação Portuguesa de Documentação tradicional, autodidatas confirmados), developer advocates, documentation engineers, product managers de plataformas API (Unbabel API, Talkdesk API, Sword Health API, Critical Software API, NOS Innovation API) e responsáveis developer experience em SaaS B2B. A assinatura visual diz imediatamente « conheço o ofício da documentação tech ».
Como utilizá-lo
A carta tech writing deve provar o domínio das ferramentas e dos frameworks: Mintlify, ReadMe, Docusaurus, Hugo, MkDocs, OpenAPI/Swagger, JSON Schema. Cite duas ou três documentações públicas que tenha escrito ou melhorado (com ligações públicas). Mencione a sua abordagem pedagógica (Diátaxis framework, Google Developer Documentation Style Guide, Microsoft Writing Style Guide). Para um developer advocate, adicione uma ou duas palestras dadas em conferência reconhecida (PyCon PT, JSConf Portugal, Web Summit Lisbon).
Perguntas frequentes
É preciso dominar o código para ser technical writer?
Sim em 90 % dos casos. Para escrever documentação API, é preciso saber ler e executar o código de forma autónoma (JavaScript, Python, Go segundo o stack). Para uma documentação produto pura (admin guide, knowledge base), o conhecimento código pode ser mais ligeiro. Indique o seu nível real em duas ou três linguagens — a precisão lê-se positivamente.
O formato doc é demasiado nicho para um grupo grande?
Para um posto de technical writer num grupo grande (NOS Innovation documentation, Glintt documentation, Critical Software documentation), o código parece nativo. Para uma função RH transversal num grupo grande não-tech, o código pode parecer fora de tópico. Adapte segundo o alcance tech do posto.
Como evocar uma migração de doc legacy?
É um tema apreciado pelos recrutadores. Cite o stack fonte (Confluence, MediaWiki, GitBook v1), o stack destino (Docusaurus, Mintlify, ReadMe v2), o volume migrado (número de páginas, número de autores), e a estratégia (auditoria, deprecation, arquivamento, redireções SEO). Para um posto senior tech writing, o domínio das migrações é sinal de seniority distintivo.
