/technical-writing-resources

A compilation of technical writing resources

MIT LicenseMIT

Technical writing is a form of communication that helps users solve problems with technology. As a technical writer, sharing your knowledge and experience with people helps you affirm that you have a solid understanding of the technology you're writing about.

What is Technical Writing?

Technical writing is a type of writing where the author is writing about a particular subject that requires direction, instruction, or explanation. This style of writing has a very different purpose and different characteristics than other writing styles. ~ YourDictionary

Outline

(back to top)

Resources

This repository contains different technical writing resources that has been gathered from all around the internet

Articles

(back to top)

Books

(back to top)

Courses

(back to top)

Youtube

(back to top)

Communities

Communities can provide valuable learning opportunities, growth, mentorship and career advancement. Connecting with people of similar interest is one of the reasons why people join communities. Here are some of the communities that technical writers can join:

(back to top)

Tools

  • Help authoring tools and content management systems for technical documentation ~ Very comprehensive market overview of authoring systems for creating technical documentation, such as online help, online documentation, and printed documents (PDF).

  • Canva ~ Canva is a graphic design platform, used to create social media graphics, presentations, posters, documents and other visual content.

  • Removebg ~ A tools that is used to remove image backgrounds.

  • Markdown ~ Markdown is a text-to-HTML conversion tool for web writers.

  • AsciiDoc ~ AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation.

  • Denigma ~ Denigma is a tool that explains code in understandable english.

  • Grammarly ~ Grammarly is a typing assistant that reviews spelling, grammar, punctuation, clarity, engagement, and delivery mistakes.

  • Hemingway App ~ The Hemingway App is a web and desktop app that can improve your writing style and touch up your content.

  • Quillbot AI ~ Quillbot AI is a multi-purpose writing tool that can assist in improving your writing style. Some of its products are Paraphraser, Grammar Checker, Plagiarism Checker, Co-Writer, Summarizer, Citation Generator, and Word Counter.

  • Notion ~ Notion is an all-in-one workspace for your notes, tasks, wikis, and databases. It is a tool you can use to organize your thoughts, projects, and information.

  • Dropbox Paper ~ Dropbox Paper is an online document workspace, where you can organize and display text, media, and files all in one place.

  • GoFullPage - Full Page Screen Capture ~ A chrome extension taht allows you take full page screenshot of your current browser window.

  • Carbon ~ Carbon is the easiest way to create and share beautiful images of your source code.

  • Isitwp ~ IsItWP Headline Analyzer tool helps you write headlines that drive traffic, shares and rank better in search results.

  • Capitalize my title ~ Making title capitalization easy for your writing

  • Wordtune ~ Wordtune turns text into concise, engaging, well-written messages.

  • Headline Analyzer ~ Write Headlines That Drive Traffic, Shares, And Search Results.

  • Title Generator ~ Generate great titles for articles and blog posts.

  • SEO writing assistant ~ A smart writing editor that helps you optimize your copy for engagement and SEO.

  • HackMD ~ A collaborative markdown editor for sharing your articles and getting feedback from others.

  • Copyscape ~ Plagiarism checker

  • MarkDoc ~ A superset of Markdown for creating custom documentation websites. It was created by Stripe and made open source in May 2022.

  • Wordtune ~ Wordtune is an AI- powered writing companion that rephrases your sentences to say exactly what you mean through clear, compelling, and authentic writing.

  • Power Thesaurus ~ Power Thesaurus is an online thesaurus for writers that is free, fast, comprehensive, and simple to use. It can help you find synonyms and acronyms.

  • Lose the Very ~ A tool that helps you replace words like "Very Good".

  • Unsplash ~ A free and safe image source for your content, without running into copyright issues.

  • Blackbox ~ It is the fastest way to copy text from videos, images, PDFs, anything.

  • Overleaf ~ An online LaTeX editor that's easy to use an mainly used to make CV.

  • Linktree ~ It is a tool that allows you to share multiple links.

  • Slidesgo ~ Helps in finding some crazy PPT templates.

  • Wallpaper haven ~ High resolution wallpapers.

  • Flaticon ~ High quality stickers and icons for free.

  • Magic Eraser ~ Removes any unwanted item from your image.

  • Jenni Ai ~ An AI auto-writing tool that automatically writes your essays and emails for you.

  • Flowcode ~ Create Dynamic QR Code for free with no restrictions.

(back to top)

Who pays technical writers

Writing technical contents for organizations and publications is an excellent way to earn extra income. This way, you learn a lot, then share your knowledge and get paid. Check out these compiled list for organizations that pays technical writers.

(back to top)

Open Source Projects

Contributing to open source can be a rewarding way to learn, teach, and build experience in just about any skill you can imagine. A lot of peole contribute to open source for different reasons and the vital one which is improving one's skillset.

Here are some articles to help you understand how to contribute to open source projects.

(back to top)

Open Source Projects/Programs Technical Writers Can Contribute To

  • Codecademy Docs ~ Docs is a community-driven collection of code documentation for popular programming languages and frameworks.
  • The Good Docs Project ~ The Good Docs Project is a community working together to create the templates, tools, and resources to improve the overall quality of documentation in OSS and beyond.
  • Google Season of Docs ~ Season of Docs provides support for open source projects to improve their documentation and gives professional technical writers an opportunity to gain experience in open source.
  • Hacktoberfest ~ Hacktoberfest is a yearly event to encourage people to contribute to open source in October.
  • The GNOME Documentation Project

(back to top)

Blogs to follow for awesome writing contents

Technical Writers Blogs Twitter Handle
Damilola Ezekiel https://dharmelolar.hashnode.dev @that_yhemmygirl
Tom Johnson https://idratherbewriting.com/ @tomjohnson
Kesi Parker https://medium.com/@kesiparker @ParkerKesi
Tania Rascia https://tania.dev/ @taniarascia
Dillion Megida https://writing.dillionmegida.com/ @iamdillion
Linda Ikechukwu https://www.everythingtechnicalwriting.com _MsLinda
Amruta Ranade https://dev.to/amrutaranade @AmrutaRanade

(back to top)

Preparing for technical writing interviews

There are several tips that can help you land an interview but some of the important ones are having a well tailored resume and cover letters. Check out these cover letter templates and tips to help you land your next interview:

Here are some resources to technical writing interview questions to help you prepare for your next interview.

(back to top)

Sites to publish articles

  • Hashnode ~ Hashnode is a free developer blogging platform to help you share your ideas with people in tech, developers, and engineers.
  • Medium ~ Medium is a social publishing platform with lots of users and you can publish diverse contents and ideas.
  • Dev.to ~ Dev.to is where programmers share ideas and help each other grow. It is an online community for sharing and discovering great ideas.
  • Mirror.xyz ~ Mirror.xyz is a publishing platform for writers that leverages cryptocurrency and blockchain technology.
  • Freecodecamp ~ FreeCodeCamp is a non-profit organization that consists of an interactive learning web platform, an online community forum, chat rooms, online publications and local organizations that intend to make learning web development accessible to anyone.

(back to top)

Types of Technical-writing

  • Instruction manuals
  • Proposals
  • Reports
  • Posters and Visual Communication
  • Technical Descriptions
  • Product Recalls
  • White Papers

(back to top)

Job Boards For Technical Writing roles

(back to top)

©2022Damilola Ezekiel

Made with ❤️ by Damilola Ezekiel