/Technical-Writing-Resources

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.

Technical Writing Resources

Technical-Writing-Resources

Hi there๐Ÿ™Œ๐Ÿพ

I hope this meets you well. This is a compilation of important links that I have come across in my journey as a writer. I hope this helps you too.

Getting Started

Blogs

Courses

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

API Documentation

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 FAQ's

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 styleguides you can get inspiration from are:

Extra:

Defining Tone Of Voice

Tools

Produtivity and Content Planning

Grammar

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

Plagarism Checker

โ†’ Quetext's plagiarism checker analyzes your text to identify plagiarism, resolve other writing issues, and build citations with ease.

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 more clear, compelling and authentic.

Graphics

โ†’ Create cover images for your articles and blog posts using Canva.

โ†’ Make drawings, highlights, blurs, on Screenshot.

โ†’ Mermaid lets you create diagrams and visualizations using text and code.

CrossPost

โ†’ CrossXpost.

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 on 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 '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.

Final Notes

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

I am glad you have taken this path and if you wanna talk, send a DM on Twitter or schedule a call here.

Speak to someone

Dillion has offered to speak to anyone with questions. Set up a call here.

Happy Learning!!!