dharmelolar/technical-writing-resources

Outline

Outline
Resources
What is Technical Writing?
Articles
Books
Courses
Youtube
Communities
Writing Tools
Documentation Tools
Who pays technical writers
Open Source Projects
- Open Source Projects/Programs Technical Writers Can Contribute To
Blogs to follow for awesome writing contents
Preparing for technical writing interviews
Sites to publish articles
Job Boards For Technical Writing roles

Resources

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

What is Technical Writing?

Technical writing is a form of communication that helps users solve problems with technology. It is the process of creating clear, concise, and informative content designed to convey complex information in a way that is easily understood by the intended audience.

It often involves writing manuals, guides, reports, and documentation that explain technical concepts, processes, or products.

Articles

Books

Writing Well ~ Julian Shapiro
Technical Writing, Simplified ~ Nell Johnson
Writing for Sotware Developers ~ Philip Kiely
Technical Writing For Dummies ~ Sheryl Lindsell-Roberts
Docs for Developers: An Engineer’s Field Guide to Technical Writing ~ Jared Bhatti
Modern Technical Writing: An Introduction to Software Documentation ~ Andrew Etter
Everybody Writes: Your Go-To Guide to Creating Ridiculously Good Content ~ Ann Handley
On Writing Well ~ William Zinsser
Technical Communication ~ Mike Markel

Courses

Technical Writing Courses for Engineers
Technical Writing: How to Write Software Documentation
Learn API Technical Writing: JSON and XML for Writers
The Art of API Documentation
Documenting APIs: A guide for technical writers and engineers
Technical Writer Certification Course ~ Technical Writer Certification Course was created for aspiring technical writers or people who want to brush up on their technical writing skills.
SEO FOR DEVS ~ SEO FOR DEVS is a free 2 weeks course that helps people discover your tech blog or side project in a systematic way
API Documentation for Developers ~ A hands-on guide to creating and maintaining API documentation.

Youtube

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:

Writing Tools

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.

Documentation Tools

GitBook ~ A modern documentation platform where teams can document everything from products to internal knowledge bases and APIs.
Read the Docs ~ An open-source platform for hosting, building, and versioning documentation.
Docusaurus ~ A static site generator that makes it easy to build open-source project websites.
Sphinx ~ A documentation generator that converts reStructuredText files into HTML websites and other formats.
MkDocs ~ A fast, simple, and static site generator that's geared towards building project documentation.
Swagger ~ A suite of tools for API documentation, including Swagger Editor, Swagger UI, and Swagger Codegen.
Postman ~ A collaboration platform for API development that makes it easy to create, share, test, and document APIs.
Slate ~ A static site generator specifically designed for API documentation.
Redoc ~ An open-source tool for generating API documentation from OpenAPI (formerly Swagger) definitions.
Docz ~ A tool for writing documentation for your React components with MDX and live-reload support.
Jekyll ~ A static site generator that transforms plain text into static websites and blogs.
Hugo ~ A fast and flexible static site generator written in Go.
Antora ~ A documentation site generator for creating documentation portals and technical documentation websites.
VuePress ~ A static site generator powered by Vue.js.
Asciidoctor ~ A fast text processor and publishing toolchain for converting AsciiDoc content to HTML5, DocBook, PDF, and other formats.
Confluence ~ A collaboration tool used to help teams collaborate and share knowledge efficiently.
MadCap Flare ~ A comprehensive technical authoring and publishing tool for creating content for various outputs.

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.

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.

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

Blogs to follow for awesome writing contents

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.

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.

Job Boards For Technical Writing roles

Made with ❤️ by Damilola Ezekiel