Skip to content

A collection of blogpost, resources, and links that has helped me in my journey as a technical writer. I still refer to them and contribute to the list as I find more.

Notifications You must be signed in to change notification settings

CynthiaPeter/Technical-Writing-Resources

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

43 Commits
ย 
ย 

Repository files navigation

Technical Writing Resources

Technical-Writing-Resources

Hi there๐Ÿ™Œ๐Ÿพ

I hope you are doing well. This is a compilation of essential links I have encountered as a writer. I hope this helps you too.

Getting Started

Technical Writing Roadmap By Hackmamba X iChuloo

Blogs

Courses

Types of Documentation You may need to do as a Technical writer:

API Documentation

Learn about APIs

  • Postman Academy By Postman. I highly recommend this resource. Taking all or any of the courses in this series will help you understand APIs and how to use Postman.
  • An introduction to APIs by Zapier. This course breaks down APIs for beginners.

Building Documentation site

Doc-as-code

4c Documentation Model

Getting Started Guide

๐Ÿ“ฐ Getting Started Guide retrospective: The good, the bad, the ugly โ€“ By Kate Mueller

Articles and Blogs

๐Ÿช„ 21 Tips to write better posts for devs.

Guides and FAQs

Style Guides

When deciding how to create content, it is important to pay attention to some companies that already have amazing styleguides to guide you. A list of remarkable style guides you can get inspiration from are:

Extra:

Defining Tone Of Voice

Tools

Technical Writing Tools

Productivity and Content Planning

Grammar

  • Grammarly helps you write mistake-free in Gmail, Facebook, Twitter, LinkedIn, and any other app you use.

Plagiarism Checker

  • Quetext's plagiarism checker analyzes your text to identify plagiarism, resolve other writing issues, and easily build citations.

Paraphrasing Tool

  • Quillbot Helps you rewrite and enhance any sentence, paragraph, or article using state-of-the-art AI.

  • Wordtune is an AI-powered writing companion that understands what youโ€™re trying to say, and suggests ways to make your writing clearer, compelling and authentic.

Graphics

CrossPost

โ†’ CrossXpost

AI Tools

Extras

โ†’ To check trends.

โ†’ Headline analyzer

โ†’ Americans with disability act.

โ†’ Writing in plain language.

โ†’ Inclusive writing for everyone.

โ†’ Passive voice detector.

Best Practices - Developer Experience(DX)

โœจ The 7 Sins of Developer Experience By Christiano Betta. This resource gives you an insight into Developer Experience.

โœจ Developer experience in terms of API design.

Community and Newsletters

Newsletters๐Ÿ“ฌโœ‰๏ธ

Podcasts๐ŸŽ™๐ŸŽ™

Books๐Ÿ“˜๐Ÿ“˜

Build your Portfolio

What a Technical Writing role entails

These are my recommendations for building a Portfolio

Find Jobs

More Learning Resources๐Ÿ“˜

๐Ÿ“˜ This page links to the topics that have been covered by conference talks or in the newsletter for the 'Write The Docs' community.

๐Ÿ“˜ Handling empty characters.

๐Ÿ“˜ If you are new to tech and need a basic introduction to computer science. Here are a couple of my favourite resources to get you started: Harvard CS50 course.

๐Ÿ“˜ Learn Markdown.

๐Ÿ“€ Seeing your docs through different eyes: Mapping doc users experiences By Aaron Collier.

๐Ÿ“€ What do you look for when hiring technical Writers By Dawn Davenport.

๐Ÿ“€ Code Samples In Documentation By Brian Murray.

๐Ÿ“€ Blog Promotion Checklist By Karl Hughes.

Learn Git - Version Control

๐Ÿ“˜ Learn Git in a Month of Lunches.

๐Ÿ“˜ GIT PURR! Git Commands Explained with Cats! By Tomomi Imura.

๐Ÿ“˜ A Visual Guide to Version Control By Better Explained.

SEO for Technical Writers

๐Ÿ–Š SEO for beginners: An Introduction to SEO Basics.

๐Ÿ–Š Search Engine Optimization: A Beginner's Guide from Ahrefs.

๐Ÿ–Š The Beginner's Guide to SEO: Rankings and traffic through search engine optimization.

Other Technical Writing Resources

๐Ÿ”— Resources on Technical writing covering Transcription, Word Processing, Defi Content Writing, Ux Writing, NFT Content Writing.

Upskill

As a technical writer, you might find yourself learning on the job. Below, you'll find links to platforms that offer both free and paid courses. I encourage you to spend some time reading and upskilling. Happy learning.

๐Ÿ”— Edx ๐Ÿ”— Google Digital Skills

Final Notes

Hey stranger, I plan to update this as much as possible. You can contribute if you find something you learned from and think we, too, can learn from.

I am glad you have taken this path, and if you want to talk, send a DM on Twitter.

Happy Learning!!!

About

A collection of blogpost, resources, and links that has helped me in my journey as a technical writer. I still refer to them and contribute to the list as I find more.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published