So, you want to get into technical writing?

Today was day 1 of the Hashnode boot camp on technical writing. Hosted by Sam Sycamore, with great presentations by Quincy Larson and Edidiong Askipo about the basics of technical writing and how to get started.

What is technical writing?

While writing is the act of marking down one's thoughts, technical writing adds the extra layer of detail, reason and explanation. The topic of technical writing is usually on something that requires explanation, instruction, and/or direction.

Before we start technical writing there is always the question of "What do I write about?" The simplest answer is, what you are learning about! Though it may seem trivial to write about things you are learning, especially as a beginner, Quincy pointed out that being a beginner is as asset as you have a "Beginner's mindset," allowing you to empathize with people who are reading your articles. The world of tech is vast, ever changing, and may be overwhelming for some. By putting your unique voice out there, you may be able to shine light on a topic in a different way that might help some who has the same questions you once had.

Researching for your topics

Before you put something out onto the internet, it is always good to cover all your bases and make sure what you are saying is true. Researching particular topics, self-learning, and knowing what information you need and how to find it are valuable skills. When you come up with the concept for an article it is best practice to try and learn all you can about what you want to write about; that should be an area of focus. Once all the information is gathered it is best to break down the subject of the article into smaller, more easily digestible parts. Make sure the information you're giving is simple, clear, and organized. Edidiong pointed to a great quote that I feel really captures the essence of this:

"If you can't explain it to a six year old, you don't understand it yourself."

Albert Einstein

By breaking down concepts into simpler ideas to better explain them to others, you also solidify your own knowledge in the subject.

Target audience

Emphasis on your target audience here is key as well. A few considerations Edidiong mentioned one should make are:

• What do they need?
• Where will they be reading?
• When will they be reading?
• Why will they be reading?
• How will they be reading?

Its important to understand who you are talking to, what their needs are and what you are offering. You don't want to start a deep dive on React components in an article about the basics of vanilla JavaScript aimed at beginners. Keeping your articles to the point and not trying to use filler to make them longer is also a good way to go.

Getting traction with your articles

Though you may not end up on the first page of a google search to start, like learning to code, consistency is key. Not only will writing on a consistent basis allow you to hone your writing skills, but, it will also start to build familiarity with your growing audience. Try not to overdo it though. You have to manage the balance between frequency and quality. Though practice makes perfect, quality should not be sacrificed for frequency. Sharing links to your articles through social media outlets like Twitter and LinkedIn can also help direct traffic to your articles.

Getting better

In closing, my biggest takeaway from day 1 is the best way to get involved in technical writing is the act of writing itself. There are other means to assist your learning like reading articles, blog posts, receiving feedback on your work, taking a course on technical writing or taking part in a boot camp.

Special thanks to Sam Sycamore and Hashnode for hosting this event as well as Quincy Larson and Edidiong Askipo for presenting.

Happy writing! 👨‍💻