Contour
- Contour
- Ressources
- Qu'est-ce que l'écriture technique?
- Articles
- Livres
- Cours
- Youtube
- Communautés
- Outils d'écriture
- Outils de documentation
- Qui paie les écrivains techniques
- Projets open source
- Projets / programmes open source Les rédacteurs techniques peuvent contribuer à
- Blogs à suivre pour des contenus d'écriture impressionnants
- Préparer des entretiens d'écriture technique
- Sites pour publier des articles
- Boards d'emploi pour les rôles d'écriture technique
Ressources
Ce référentiel contient différentes ressources d'écriture technique qui ont été recueillies sur Internet
Qu'est-ce que l'écriture technique?
La rédaction technique est une forme de communication qui aide les utilisateurs à résoudre des problèmes de technologie. Il s'agit du processus de création de contenu clair, concis et informatif conçu pour transmettre des informations complexes d'une manière qui est facilement comprise par le public prévu.
Cela implique souvent des manuels, des guides, des rapports et de la documentation qui expliquent les concepts techniques, les processus ou les produits.
Articles
- Écriture technique au-delà des articles de blog
- Comment commencer avec l'écriture technique
- Comment devenir écrivain technique
- Écriture technique pour les débutants - un guide AZ pour les bases des blogs technologiques
- Écriture technique: quoi et comment?
- Comment apprendre l'écriture technique gratuitement
- Début avec l'écriture technique
- Conseils pour la rédaction technique
- Comment rédiger du contenu que les lecteurs liront en fonction des apprentissages de la psychologie des utilisateurs
- Comment créer un portefeuille d'écriture technique
- Conseils d'écriture pour les développeurs de logiciels - Comment devenir un meilleur écrivain technologique
- 11 meilleures pratiques pour écrire la documentation de l'API
- Écriture technique vs blogs techniques
Livres
Bien écrire ~ Julian Shapiro
Écriture technique, simplifiée ~ Nell Johnson
Écriture pour les développeurs de sotware ~ Philip Kiely
Écriture technique pour les nuls ~ Sheryl Lindsell-Roberts
Docs for Developers: Un ingénieur Guide sur le terrain de l'écriture technique ~ Jared Bhatti
Écriture technique moderne: une introduction à la documentation logicielle ~ Andrew Etter
Tout le monde écrit: Votre guide incontournable pour créer un contenu ridiculement bon ~ Ann Handley
En écrivant bien ~ William Zinsser
Communication technique ~ Mike Markel
Cours
- Cours de rédaction technique pour les ingénieurs
- Rédaction technique: comment rédiger une documentation logicielle
- Apprenez l'écriture technique de l'API: JSON et XML pour les écrivains
- L'art de la documentation API
- Documenter les API: un guide pour les écrivains et ingénieurs techniques
- Cours de certification technique de l'écrivain ~ Cours de certification des écrivains techniques a été créé pour les aspirants écrivains techniques ou les personnes qui souhaitent se réprimer leurs compétences en rédaction technique.
- SEO pour les développeurs ~ SEO pour les développeurs est un cours gratuit de 2 semaines qui aide les gens à découvrir votre blog technologique ou votre projet parallèle de manière systématique
- Documentation de l'API pour les développeurs ~ un guide pratique pour créer et maintenir la documentation de l'API.
Youtube
- Doctohelptv
- HQ auteur technique
- Amruta Ranade
- William Smith
- Comment devenir écrivain technique | Compétences et croissance de carrière
Communautés
Les communautés peuvent offrir des opportunités d'apprentissage précieuses, une croissance, un mentorat et un progrès professionnel. Se connecter avec des personnes d'intérêt similaire est l'une des raisons pour lesquelles les gens rejoignent les communautés. Voici quelques-unes des communautés que les rédacteurs techniques peuvent rejoindre:
- Écrivez les documents
- Docnext
- Hackmamba
- Communauté d'écriture technique LinkedIn
- Communauté des écrivains mondiaux
- Groupe de documentation API
- Forum d'écrivain technique
- Hashode
- La communauté du Good Docs Project
- Techwriters.dev
- R / écriture technique
Outils d'écriture
- Canva ~ Canva est une plate-forme de conception graphique, utilisée pour créer des graphiques de médias sociaux, des présentations, des affiches, des documents et d'autres contenus visuels.
- Retirebg ~ un outil utilisé pour supprimer les arrière-plans de l'image.
- Markdown ~ Markdown est un outil de conversion text-to-html pour les écrivains Web.
- Asciidoc ~ Asciidoc est un langage de balisage léger et sémantique principalement conçu pour rédiger une documentation technique.
- Denigma ~ denigma est un outil qui explique le code en anglais compréhensible.
- Grammarly ~ Grammarly est un assistant de frappe qui passe en revue l'orthographe, la grammaire, la ponctuation, la clarté, l'engagement et les erreurs de livraison.
- Application Hemingway ~ L'application Hemingway est une application Web et de bureau qui peut améliorer votre style d'écriture et retoucher votre contenu.
- Quillbot ai ~ Quillbot Ai est un outil d'écriture polyvalent qui peut aider à améliorer votre style d'écriture. Certains de ses produits sont paraphraser, un vérificateur de grammaire, un vérificateur de plagiat, un co-scénariste, un résumé, un générateur de citation et un compteur de mots.
- Notion ~ La notion est un espace de travail tout-en-un pour vos notes, tâches, wikis et bases de données. Il s'agit d'un outil que vous pouvez utiliser pour organiser vos pensées, projets et informations.
- Dropbox Paper ~ Dropbox Paper est un espace de travail de document en ligne, où vous pouvez organiser et afficher du texte, des médias et des fichiers en un seul endroit.
- Gofullpage - Capture d'écran pleine page ~ Une extension chromée Taht vous permet de prendre une capture d'écran pleine page de votre fenêtre de navigateur actuel.
- Carbon ~ Le carbone est le moyen le plus simple de créer et de partager de belles images de votre code source.
- L'outil ISITWP ~ ISITWP L'outil d'analyseur vous aide à rédiger les titres qui stimulent le trafic, les partages et le classement mieux dans les résultats de recherche.
- Capitaliser mon titre ~ faciliter la capitalisation du titre pour votre écriture
- WordTune ~ Wordtune transforme le texte en messages concis, engageants et bien écrits.
- Headline Analyzer ~ Écrivez les titres qui stimulent le trafic, les partages et les résultats de recherche.
- Générateur de titres ~ Générez de grands titres pour les articles et les articles de blog.
- Assistant d'écriture de référencement ~ un éditeur d'écriture intelligent qui vous aide à optimiser votre copie pour l'engagement et le référencement.
- HackMd ~ un éditeur de Markdown collaboratif pour partager vos articles et obtenir des commentaires des autres.
- Copyscape ~ Plagiarism Checker
- Markdoc ~ un superset de Markdown pour créer des sites Web de documentation personnalisés. Il a été créé par Stripe et a fait l'open source en mai 2022.
- Wordtune ~ Wordtune est un compagnon d'écriture alimentaire qui reproche vos phrases pour dire exactement ce que vous entendez par une écriture claire, convaincante et authentique.
Outils de documentation
- Gitbook ~ Une plate-forme de documentation moderne où les équipes peuvent tout documenter, des produits aux bases de connaissances internes et aux API.
- Lisez les documents ~ une plate-forme open source pour l'hébergement, la construction et la documentation de version.
- Docusaurus ~ un générateur de sites statique qui facilite la création de sites Web de projets open source.
- Sphinx ~ un générateur de documentation qui convertit les fichiers restructurés en sites Web HTML et autres formats.
- Mkdocs ~ un générateur de sites rapides, simple et statique axé sur la documentation du projet.
- Swagger ~ une suite d'outils pour la documentation de l'API, notamment Swagger Editor, Swagger UI et Swagger Codegen.
- Postman ~ Une plate-forme de collaboration pour le développement d'API qui facilite la création, partager, tester et documenter les API.
- Slate ~ Un générateur de sites statique spécialement conçu pour la documentation de l'API.
- Redoc ~ Un outil open-source pour générer une documentation API à partir des définitions OpenAPI (anciennement Swagger).
- Docz ~ Un outil pour rédiger de la documentation pour vos composants React avec MDX et support de recharge en direct.
- Jekyll ~ un générateur de sites statique qui transforme le texte brut en sites Web et blogs statiques.
- Hugo ~ Un générateur de sites statique rapide et flexible écrit en Go.
- Antora ~ un générateur de sites de documentation pour créer des portails de documentation et des sites Web de documentation technique.
- Vuepress ~ un générateur de sites statique propulsé par Vue.js.
- ASCIIDOCTOR ~ Un processeur de texte rapide et une chaîne d'outils de publication pour convertir le contenu ASCIIDOC en formats HTML5, DocBook, PDF et autres.
- Confluence ~ Un outil de collaboration utilisé pour aider les équipes à collaborer et à partager efficacement les connaissances.
- Madcap Flare ~ un outil de création technique et de publication complet pour créer du contenu pour diverses sorties.
Qui paie les écrivains techniques
La rédaction du contenu technique des organisations et des publications est un excellent moyen de gagner un revenu supplémentaire. De cette façon, vous apprenez beaucoup, puis partagez vos connaissances et êtes payé. Consultez cette liste compilée pour les organisations qui paie les rédacteurs techniques.
- Programme d'écrivain communautaire
- Être payé pour écrire pour ces 45+ sites Web
- Publications qui vous paient pour écrire des articles techniques
Projets open source
Contribuer à l'open source peut être un moyen gratifiant d'apprendre, d'enseigner et de développer l'expérience dans à peu près toutes les compétences que vous pouvez imaginer. Beaucoup de Peole contribuent à l'open source pour différentes raisons et celle vitale qui améliore ses compétences.
Voici quelques articles pour vous aider à comprendre comment contribuer à des projets open source.
- Open source pour les écrivains techniques
- Le Guide des rédacteurs techniques pour contribuer aux projets open source
- Comment contribuer à l'ouverture en tant qu'écrivain technique
- 4 conseils pour devenir écrivain technique avec des contributions open source
- Début avec l'open source en tant qu'écrivain technique
Projets / programmes open source Les rédacteurs techniques peuvent contribuer à
- CodeCademy Docs ~ Docs est une collection communautaire de documentation de code pour les langages et les cadres de programmation populaires.
- The Good Docs Project ~ The Good Docs Project est une communauté travaillant ensemble pour créer les modèles, les outils et les ressources pour améliorer la qualité globale de la documentation dans l'OSS et au-delà.
- Google Saison de Docs ~ Saison de DOCS fournit un soutien aux projets open source pour améliorer leur documentation et donne aux écrivains techniques professionnels l'occasion d'acquérir de l'expérience en open source.
- Hacktoberfest ~ Hacktoberfest est un événement annuel pour encourager les gens à contribuer à l'open source en octobre.
- Le projet de documentation GNOME
Blogs à suivre pour des contenus d'écriture impressionnants
- Techwriters Hub
- Kesi Parker
- Idratherbewriting
- Tout l'écriture technique
- Hub writetech
- Hackmamba
Préparer des entretiens d'écriture technique
Il existe plusieurs conseils qui peuvent vous aider à décrocher une entrevue, mais certaines des importantes ont un CV bien sur mesure et des lettres de motivation. Découvrez ces modèles et conseils de lettres d'accompagnement pour vous aider à décrocher votre prochaine interview:
- Modèle de lettre de motivation pour votre prochain emploi
- Comment rédiger une lettre de motivation séduisante
- Comment rédiger un curriculum vitae technique [+ exemples]
- Meilleur exemple de lettre de motivation technique de l'écrivain et format
Voici quelques ressources pour rédiger des questions d'entrevue technique pour vous aider à vous préparer à votre prochain entretien.
- 12 Questions et réponses d'interview de l'écrivain technique
- Questions d'interview de Google Technical Writer
- Entretien d'embauche de rédaction technique
Sites pour publier des articles
- Hashnode ~ Hashnode est une plate-forme de blogs de développeurs gratuite pour vous aider à partager vos idées avec des personnes en technologie, développeurs et ingénieurs.
- Medium ~ Medium est une plate-forme de publication sociale avec beaucoup d'utilisateurs et vous pouvez publier divers contenus et idées.
- Dev.to ~ dev.to est l'endroit où les programmeurs partagent des idées et s'entraident à grandir. C'est une communauté en ligne pour partager et découvrir de grandes idées.
- Mirror.xyz ~ Mirror.xyz est une plate-forme de publication pour les écrivains qui exploite la crypto-monnaie et la technologie de la blockchain.
- FreeCodeCamp ~ FreeCodeCamp est une organisation à but non lucratif qui se compose d'une plate-forme Web d'interactive d'apprentissage, d'un forum communautaire en ligne, de salles de chat, de publications en ligne et d'organisations locales qui ont l'intention de rendre le développement Web d'apprentissage accessible à quiconque.
Boards d'emploi pour les rôles d'écriture technique
Fabriqué avec ❤️ par Damilola Ezekiel
