My Technical Writing Journey

A review of my journey in writing Technical documentation

Introduction

When I wrote my first two technical articles, I sucked at many things. I made mistakes, but I learned from them. The title for my second article was “Front-end Template 2023.” I’m sure you’re wondering, what the heck is that? Although I’ve deleted this from my account because it was that terrible 😅😅.

However, I’ve learned from my mistakes. I’m writing this article to outline the mistakes and how I was able to fix them. Follow me.

Mistakes and How I Fixed Them

Add Good Title

My previous title, “Front-end Template 2023,” was vague and did not convey the right message. However, I changed the title to “Front-End Web Development Roadmap for Beginners 2023,” which gave the right message. It showed that the title was for beginners who want to learn front-end web development.

Too much Jargons

I used too many technical terms in the old draft, such as IDE, framework, and version control. I did not even explain or define them. However, after reviewing other works, I made corrections by presenting them in simple terms. I also gave examples of IDE, version control, and framework.

Image showing IDE used by developers

Add Structure

Previously, I did not include a table of contents and introduction, but I later fixed this by writing a brief introduction and adding a table of contents for easy navigation.

image showing table of content for my article on "Introduction to Front-end web development for Beginners 2023"

Add Examples

When explaining backend languages, I did not give examples. Later, I included backend languages such as Java, Ruby, and PHP.

types of backend programming languages

Proofreading is Important

Sometimes, my eyes cannot detect some errors, but Grammarly was able to help me in that aspect.

No Specific Audience

The old title did not target any demographic, which made it too broad and generic. I later made corrections and wrote the article only for beginners.

Poor Formatting

After my Technical Writing course, I learned the importance of headings, subheadings, and bullet points. I later implemented this in my article.

Feedback is Important

During my first few months as a technical writer, I did not ask others to review my book. However, with time, collaboration made me a better technical writer as other people relate their experiences with me. I then apply these experiences to my work.

Add Images

After writing for some time, I discovered that images are a better way of presenting information than words. I added images to my work to make it easier for the readers to understand.

Conclusion

I became a better technical writer thanks to collaboration with other technical writers. I also purchased a technical writing course; these things made me a better writer. For beginners, ensure you collaborate, take courses, research, and keep learning.