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
- 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.
- What is Technical Writing By TechnicalWriterHq
- A software developer's guide to Writing By Ankur Tyagi
Courses
- Learn Tech Writing by Arnab Ghosh.
- Tech Writers Master Class By Janet Underwood.
Types of Documentation You may need to do as a Technical writer:
API Documentation
- Working with APIs By KnowlegdeOwl.
- 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.
Learn about APIs
- Postman Academy By Postman. This resource is highly recommended by me. Taking all or any of the courses in this series will help you understand APIs and how to use Postman.
Getting Started Guide
Articles and Blogs
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:
- 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.
- The FreeCodeCamp Publication Style Guide.
Extra:
- How to write your style guide as a Technical Writer By Segun Olumide.
Defining Tone Of Voice
-
Microsoft's brand voice: Above all, simple and human.
-
Atlassian Design System - Voice and design Principles.
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.
โ 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
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.
Books๐๐
-
Docs for Developers; An Engineerโs Field Guide to Technical 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
What a Technical Writing role entails
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.
- Careers.google - How we hire
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.
Learn Git - Version Control
๐ Learn Git in a Month of Lunches.
SEO for Technical Writers
Other Technical Writing Resources
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!!!