Getting Started in Technical Writing

A compilation of resources for anyone who wants to get started or learn more about technical writing.

We would greatly appreciate a Star if you like our project ⭐

What is Technical Writing ?

One of my favourite explanations of technical writing comes from Tom Johnson, who defines it as the interaction of simplicity and complexity.

I'd define technical writing as a form of writing where the author discusses a specific topic that calls for direction, instruction, or explanation.

To learn more about technical writing, explore the resources and discussion page

Contributing

This project exists thanks to all the people who contribute! ❤️ 💙

View our list of contributors here

How to contribute?

Before making any contributions, please take a look at our Code of Conduct and the Contributing Guidelines.

Wanna make a contribution but don't know how? Check out the how to contribute page.

Learning resource

• Technical Writing Resources

• Technical Writing and documentation Courses

• Docs as Code, documentation, APIs, and everything in between

• Search Engine Optimization (SEO)

• Learning markdown

• Simple Git commands

• Contributing to publications and open source as a technical writer

• Resume, portfolio, interviews, and everything in between

• Productivity, writer's block, and everything in between

• Speaking at Technical Writing communities and conferences

Technical writing bootcamp

• Getting started slides from Empower Her Community in collaboration with Non Tech in Tech bootcamp July/August 2022 .

• Technical writing slides

Getting paid

• Paid Community Writer Programs

• Who Pays Technical Writers?

• ContentWritingJobs.com by Tom

• Write the Docs Job Board

• Remotive

• Startup.jobs

• Draft.dev

• Draft.dev DevRel career

• Blockchain and Crypto Writing Jobs

• WorkingInContent.com

• UX Content Collective

• Kaitlyn Arford's freelancer newsletter

• CSS-tricks

• ContentLab

• Giskard

Technical Writing Communities

“Alone, we can do so little; together, we can do so much” – Helen Keller

• Let's Talk Technical Writing: Bi-weekly Twitter spaces about Technical writing

• Devwrites Africa. To join, send a dm to Collins or Benny.

• Write the Docs: The largest and a global community of people who care about documentation. Join the slack

  • Write the Docs Nigeria Twitter
  • Write the Docs Kenya Twitter. event page
  • Find Write the Docs Meetups in your local community here

• Non Tech in Tech: Technical Writing Clan. Join the slack group here

• UX writing: Content + UX

• THE UX WRITING LIBRARY

• Content Strategy

Share knowledge and speaking at Technical Writing communities and conferences

To learn more about speaking, check out the talk, conference, and speaking page

Need to contact someone?

You can reach out to me (Benny Ifeanyi) on Twitter

The GitHub Octodex images used in this repo was gotten from the official website

We would greatly appreciate a Star if you like our project ⭐