A Technical Writer' Journey

By Jaya Priya Sundararajan

Not long back, as a newbie technical writer, I packed my bag with questions and set out to wander across the Net hoping to find some answers. In true dismay, I came back with more questions and felt more lost than ever. That’s when I chanced upon this simple-looking, yet informative Website called Docsymmetry.com. I indulged myself here for quite a long time and needless to say, my bag got lighter. Till today, I find this Website as useful as it was in my first experience.

Docsymmetry.com is a Website maintained by Lyndsey Amott, the popular writer and editor. From hiring a technical writer to communicating with SMEs, from audience analysis to technical writing, from document design layout to writing process, this site says it all.

Hiring a Tech Writer can be one of the most challenging tasks, particularly with the rise in the number of people with varied backgrounds and a wide range of experience getting into this field. Apart from listing out the factors that one has look out for while hiring a technical writer, Lyndsey has also given a link called “7 Interviewer Interview questions for first timers” which provides great tips on interviewing.

Becoming a Tech Writer section provides tips on getting a technical writing job for people without experience. This section focuses on freshers or people with less experience in the industry. Apart from the grammar tips, Lyndsey also lists instructions on basics like the creation of a sample book and the editing test.

Audience Analysis is often ignored while writing as it can be strenuous to some. Lyndsey has listed out the basic questions one must ask essentially before writing a technical document.

The SMEs section covers the nitty-gritties we face while taking inputs from the technical folks. This page also lists the dos and don’ts one should follow while communicating with the Subject Matter Experts.

One thing that many of us want to accomplish, yet often fail, is writing without making Common Errors. This section lists out the description of all the common errors to avoid while writing. In addition, Lyndsey has also given tips on organizing the content using the right template.

The Writing Process section is definitely one thing that all the newbies must check in this Website. This section provides an idea about the phases of Technical Writing and tips on managing these phases in the most ideal way.

Document Design and Layout is something that every technical writer would have done at least once, be it a fresher or an experienced technical writer. Lyndsey, in this section, has listed out the various types of layouts often used across a document.

Have you ever been asked to write a glossary, and found it very annoying because nobody answers your queries, or because you run short of time? To rescue you from such the worries, here is a section that talks about Writing Glossaries. Lyndsey has also added the very useful “Guidelines for Writing a Glossary and Tips for checking your Glossary.”

Writing Copyrights could be risky if not written properly. You can find techniques for writing copyright and trademark notices in this site.

While Editing Your Work could be tedious and time-consuming, it is something that you certainly cannot miss out as editing your own work eliminates the chances of more errors. Lyndsey suggests a few tips that you can use as a checklist before you send your document for review.

With so many Websites around, it is indeed a tough task finding the right site at one shot. That’s where Docsymmetry comes into picture with a unique feature of capturing everything in one place. Certainly, this site is worth a deal for people looking for guidance on technical writing.

Jaya Priya is an Information Developer with Honeywell Technology Solutions Lab Pvt. Ltd