Contorno
- Contorno
- Recursos
- O que é escrita técnica?
- Artigos
- Livros
- Cursos
- YouTube
- Comunidades
- Ferramentas de escrita
- Ferramentas de documentação
- Quem paga escritores técnicos
- Projetos de código aberto
- Projetos/programas de código aberto escritores técnicos podem contribuir para
- Blogs a seguir para obter um conteúdo incrível de escrita
- Preparando -se para entrevistas técnicas de escrita
- Sites para publicar artigos
- Placos de empregos para funções de escrita técnica
Recursos
Este repositório contém diferentes recursos de escrita técnica que foram coletados de toda a Internet
O que é escrita técnica?
A escrita técnica é uma forma de comunicação que ajuda os usuários a resolver problemas com a tecnologia. É o processo de criação de conteúdo claro, conciso e informativo projetado para transmitir informações complexas de uma maneira que é facilmente compreendida pelo público -alvo.
Geralmente, envolve a redação manuais, guias, relatórios e documentação que explicam conceitos, processos ou produtos técnicos.
Artigos
- Redação técnica além dos posts do blog
- Como começar com a escrita técnica
- Como se tornar um escritor técnico
- Redação técnica para iniciantes - um guia AZ para básicos de blogs tecnológicos
- Escrita técnica: o que e como?
- Como aprender escrita técnica de graça
- Introdução com a escrita técnica
- Conselhos para redação técnica
- Como escrever conteúdo que os leitores lerão com base nos aprendizados da psicologia do usuário
- Como criar um portfólio de redação técnica
- Escrevendo dicas para desenvolvedores de software - como se tornar um escritor de tecnologia melhor
- 11 práticas recomendadas para escrever documentação da API
- Redação técnica vs blogs técnicos
Livros
Escrevendo bem ~ Julian Shapiro
Escrita técnica, simplificada ~ Nell Johnson
Escrevendo para os desenvolvedores da Sotware ~ Philip Kiely
Redação técnica para manequins ~ Sheryl Lindsell-Roberts
Documentos para desenvolvedores: um guia de campo de engenheiro para redação técnica ~ Jared Bhatti
Escrita técnica moderna: uma introdução à documentação do software ~ Andrew Etter
Todo mundo escreve: seu guia preferido para criar conteúdo ridiculamente bom ~ Ann Handley
Ao escrever bem ~ William Zinsser
Comunicação técnica ~ Mike Markel
Cursos
- Cursos de redação técnica para engenheiros
- Escrita técnica: como escrever documentação de software
- Aprenda a API Technical Writing: JSON e XML para escritores
- A arte da documentação da API
- Documentando APIs: um guia para escritores e engenheiros técnicos
- Curso de certificação de escritor técnico ~ Curso de certificação de escritor técnico foi criado para aspirantes a escritores técnicos ou pessoas que desejam aprimorar suas habilidades de escrita técnica.
- SEO para desenvolvedores ~ SEO para desenvolvedores é um curso gratuito de 2 semanas que ajuda as pessoas a descobrir seu blog de tecnologia ou projeto paralelo de uma maneira sistemática
- Documentação da API para desenvolvedores ~ um guia prático para criar e manter a documentação da API.
YouTube
- Doctohelptv
- Technical Writer HQ
- Amruta Ranade
- William Smith
- Como se tornar um escritor técnico | Habilidades e crescimento da carreira
Comunidades
As comunidades podem oferecer oportunidades valiosas de aprendizado, crescimento, orientação e avanço na carreira. Conectar -se com pessoas de interesse semelhante é uma das razões pelas quais as pessoas se juntam às comunidades. Aqui estão algumas das comunidades em que os escritores técnicos podem participar:
- Escreva os documentos
- Docnext
- Hackmamba
- Comunidade de redação técnica do LinkedIn
- Comunidade global de escritores
- Grupo de Documentação da API
- Fórum de escritor técnico
- Hashnode
- A comunidade do projeto Good Docs
- TechWriters.Dev
- R/TechnicalWriting
Ferramentas de escrita
- O Canva ~ Canva é uma plataforma de design gráfico, usada para criar gráficos de mídia social, apresentações, pôsteres, documentos e outros conteúdos visuais.
- Remova as ferramentas que são usadas para remover fundos de imagem.
- Markdown ~ Markdown é uma ferramenta de conversão de texto para HTML para escritores da Web.
- Asciidoc ~ asciidoc é uma linguagem de marcação leve e semântica projetada principalmente para escrever documentação técnica.
- Denigma ~ Denigma é uma ferramenta que explica o código em inglês compreensível.
- Gramática ~ Gramática é um assistente de digitação que analisa erros de ortografia, gramática, pontuação, clareza, engajamento e entrega.
- App Hemingway ~ O aplicativo Hemingway é um aplicativo web e desktop que pode melhorar seu estilo de escrita e retocar seu conteúdo.
- Quillbot ai ~ quillbot ai é uma ferramenta de escrita multiuso que pode ajudar a melhorar seu estilo de escrita. Alguns de seus produtos são parafraser, verificador de gramática, verificador de plágio, co-roteirista, resumo, gerador de citações e contador de palavras.
- Noção ~ A noção é um espaço de trabalho tudo-em-um para suas anotações, tarefas, wikis e bancos de dados. É uma ferramenta que você pode usar para organizar seus pensamentos, projetos e informações.
- Dropbox Paper ~ Dropbox Paper é um espaço de trabalho de documento on -line, onde você pode organizar e exibir texto, mídia e arquivos em um só lugar.
- GofullPage - Captura de tela de página inteira ~ uma extensão Chrome Taht permite que você tire a captura de tela de página inteira da janela atual do navegador.
- Carbono ~ Carbono é a maneira mais fácil de criar e compartilhar belas imagens do seu código -fonte.
- A ferramenta ISITWP ~ ISITWP Headline Analyzer ajuda a escrever manchetes que acionam o tráfego, compartilham e classificam melhor nos resultados da pesquisa.
- Capitalize meu título ~ facilitando a capitalização do título para sua redação
- WordTune ~ WordTune transforma o texto em mensagens concisas, envolventes e bem escritas.
- Analisador de manchete ~ Escreva manchetes que acionam o tráfego, compartilha e resultados de pesquisa.
- Gerador de título ~ Gere ótimos títulos para artigos e postagens de blog.
- Assistente de redação de SEO ~ um editor de redação inteligente que ajuda a otimizar sua cópia para engajamento e SEO.
- Hackmd ~ Um editor colaborativo de Markdown por compartilhar seus artigos e obter feedback de outras pessoas.
- Copyscape ~ verificador de plágio
- Markdoc ~ um superconjunto de Markdown para criar sites de documentação personalizados. Foi criado pela Stripe e feito de código aberto em maio de 2022.
- WordTune ~ WordTune é um companheiro de escrita de Ai- que reformula suas frases para dizer exatamente o que você quer dizer com uma escrita clara, convincente e autêntica.
Ferramentas de documentação
- GitBook ~ Uma plataforma de documentação moderna, onde as equipes podem documentar tudo, desde produtos a bases de conhecimento interno e APIs.
- Leia os documentos ~ uma plataforma de código aberto para hospedagem, construção e documentação de versões.
- Docusaurus ~ um gerador de sites estáticos que facilita a criação de sites de projetos de código aberto.
- Esfinge ~ Um gerador de documentação que converte arquivos reestruturados em sites HTML e outros formatos.
- Mkdocs ~ um gerador de sites rápido, simples e estático que é voltado para a criação de documentação do projeto.
- Swagger ~ um conjunto de ferramentas para a documentação da API, incluindo Swagger Editor, UI da Swagger e Swagger CodeGen.
- Postman ~ Uma plataforma de colaboração para o desenvolvimento da API que facilita a criação, o compartilhamento, o teste e o documento de APIs.
- Slate ~ Um gerador de local estático projetado especificamente para documentação da API.
- Redoc ~ Uma ferramenta de código aberto para gerar documentação da API a partir de definições do OpenAPI (anteriormente Swagger).
- DOCZ ~ Uma ferramenta para escrever documentação para seus componentes do React com suporte ao MDX e Live-ReloCa.
- Jekyll ~ um gerador de sites estáticos que transforma o texto simples em sites e blogs estáticos.
- Hugo ~ um gerador de local estático rápido e flexível escrito em Go.
- Antora ~ um gerador de site de documentação para criar portais de documentação e sites de documentação técnica.
- Vuepress ~ Um gerador de local estático alimentado por vue.js.
- Asciidoctor ~ um processador de texto rápido e uma cadeia de ferramentas de publicação para converter conteúdo ASCIIDOC em HTML5, DOCBook, PDF e outros formatos.
- Confluência ~ Uma ferramenta de colaboração usada para ajudar as equipes a colaborar e compartilhar o conhecimento com eficiência.
- Madcap Flare ~ Uma ferramenta abrangente de publicação e publicação técnica para criar conteúdo para várias saídas.
Quem paga escritores técnicos
Escrever conteúdo técnico para organizações e publicações é uma excelente maneira de obter renda extra. Dessa forma, você aprende muito, então compartilha seu conhecimento e é pago. Confira estas listas compiladas para organizações que pagam escritores técnicos.
- Programa de escritor comunitário
- Ser pago para escrever para esses 45 mais de sites
- Publicações que pagam você para escrever artigos técnicos
Projetos de código aberto
Contribuir para o código aberto pode ser uma maneira gratificante de aprender, ensinar e construir experiência em praticamente qualquer habilidade que você possa imaginar. Muita peolo contribui para o código aberto por diferentes razões e o vital que está melhorando o conjunto de habilidades.
Aqui estão alguns artigos para ajudá -lo a entender como contribuir para projetos de código aberto.
- Código aberto para escritores técnicos
- O Guia de Escritores Técnicos para contribuir para projetos de código aberto
- Como contribuir para a fonte aberta como escritor técnico
- 4 dicas para se tornar um escritor técnico com contribuições de código aberto
- Introdução ao código aberto como escritor técnico
Projetos/programas de código aberto escritores técnicos podem contribuir para
- Codecademy Docs ~ Docs é uma coleção comunitária de documentação de código para linguagens e estruturas de programação populares.
- O Projeto Good Docs ~ O projeto Good Docs é uma comunidade que trabalha em conjunto para criar modelos, ferramentas e recursos para melhorar a qualidade geral da documentação na OSS e além.
- O Google Season of Docs ~ Season of Docs fornece suporte para projetos de código aberto para melhorar sua documentação e oferece aos escritores técnicos profissionais a oportunidade de ganhar experiência em código aberto.
- Hacktoberfest ~ Hacktoberfest é um evento anual para incentivar as pessoas a contribuir para o código aberto em outubro.
- O projeto de documentação do Gnome
Blogs a seguir para obter um conteúdo incrível de escrita
- TechWriters Hub
- Kesi Parker
- IdratherBewriting
- Tudo que está escrita técnica
- WRITETECH HUB
- Hackmamba
Preparando -se para entrevistas técnicas de escrita
Existem várias dicas que podem ajudá -lo a conseguir uma entrevista, mas algumas das importantes estão tendo um currículo e cartas de cobertura bem personalizados. Confira esses modelos de carta de apresentação e dicas para ajudá -lo a conseguir sua próxima entrevista:
- Modelo de carta de apresentação para o seu próximo trabalho
- Como escrever uma carta de apresentação atraente
- Como escrever um currículo de escritor técnico [+exemplos]
- Melhor exemplo e formato de carta de apresentação do escritor técnico
Aqui estão alguns recursos para perguntas técnicas em entrevistas para escrever para ajudá -lo a se preparar para a sua próxima entrevista.
- 12 perguntas e respostas de entrevistas técnicas ao escritor
- Google Technical Writer Entrevistes Perguntas
- Entrevista de emprego de redação técnica
Sites para publicar artigos
- Hashnode ~ Hashnode é uma plataforma de blog de desenvolvedor gratuita para ajudá -lo a compartilhar suas idéias com pessoas em tecnologia, desenvolvedores e engenheiros.
- Médio ~ Médio é uma plataforma de publicação social com muitos usuários e você pode publicar diversos conteúdos e idéias.
- Dev.To ~ Dev.To é onde os programadores compartilham idéias e se ajudam a crescer. É uma comunidade on -line para compartilhar e descobrir ótimas idéias.
- Mirror.xyz ~ Mirror.xyz é uma plataforma de publicação para escritores que utiliza a tecnologia de criptomoeda e blockchain.
- Freecodecamp ~ Freecodecamp é uma organização sem fins lucrativos que consiste em uma plataforma interativa de aprendizado de aprendizado, um fórum da comunidade on-line, salas de bate-papo, publicações on-line e organizações locais que pretendem tornar o aprendizado do desenvolvimento da web acessível a qualquer pessoa.
Placos de empregos para funções de escrita técnica
Feito com ❤️ por Damilola Ezekiel
