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

• A beginners guide to get started with technical writing By Cynthia Peter.
• Technical Writing - A beginners Guide By Bekah Hawrot Weigel.
• What is Technical Writing By UX Writing Hub.
• Everything You need to Know about Technical Writing By Lynda.
• Technical Writing - The what and How By Edidiong Asikpo.
• What is Technical Writing? by Kara Latz.
• Tech Writers Master Class By Janet Underwood.
• Learn Tech Writing.
• What is Technical Writing By TechnicalWriterHq

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

API Documentation

• Working with APIs.
• Postman Learning center for API docs.
• Documenting APIs A guide for technical writers and engineers.
• API Docs for Devs By Shalvah.
• Getting Started in API Documentation By Robert Delwood.

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

• ReadTheDocs - Writing Documentation Guide.

What a Technical Writing role entails

• Sample of Technical Writer responsibilities.

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:

• Microsoft.
• Google provides editorial guidelines for writing clear and consistent Google-related developer documentation.
• Diátaxis - A systematic framework for technical documentation authoring.
• Gitlab Style Guide.
• Alistapart Style Guide.
• Gatsby StyleGuides.
• How to write your style guide as a Technical Writer By Segun Olumide.

Defining Tone Of Voice

• Monzo.

• Microsoft's brand voice: Above all, simple and human.

• Atlassian Design System - Voice and design Principles.

• Shopify Voice and Tone.

Tools

Produtivity and Content Planning

• How I use Notion for my Article and Content Ideas By Dillion Megida.
• Feedly lets you get the news you want all in one place.

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.

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

• Technical Typers community.
• Reddit.
• Non Technical in Tech.
• Linkedin Technical Writing Group.

Newsletters📬✉️

• The everything technical writing newsletter By Linda Ikechukwu.

• Dentry Newsletter By William Imoh : Receive entry-level and intermediate roles in software engineering, design, and product management.

Podcasts🎙🎙

• Thenotboringtechwriter Podcast By Jacob Moses.

• Technical Marketing Handbook.

• 10 Mins Tech Comm.

Books📘📘

• Open Technical Communication!.

• Docs for Developers; An Engineer’s Field Guide to Technical Writing.

• The Mayfield Handbook of technical and Scientific Writing.

• Writing Handbook by Julian Shapiro.

• Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content By by Alan S. Pringle, Sarah S. O'keefe.

Build your Portfolio

These are my recommendations on building a Portfolio

• Create your Blog and publish as you learn. The first two options doesn't require you to be technical to set things up;

  • Hashnode
  • Dev.to
  • Or create a more personalized website using Wix, Webflow, or Wordpress.

• Contribute to Open source Projects.

  • Technical Writers Guide to Contributing to Open Source By Edidiong Asikpo.

• Create Your Resume and Cover Letter

  • Cover Letter Template By Dillion Megida.

Find Jobs

• Content Writing Jobs: Hand-picked writing opportunities to work from home, remotely, freelance, full-time, part-time, contract and internships.
• Pocket Writer Job boards List.
• Smashing Magazine.
• CSS Tricks.
• Educative.io.
• Sitepoint.

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!!!