documentation

Writing tools are of critical importance

Which is the best and the most reliable technical content writing software for any technical content writer?

There isn’t one tool that I’d pinpoint as the best of all. But based on your organization’s standard processes, requirements, budget, delivery formats, and time at hand, you can still zero in on what software you require for your organization.

Three Tips to Internationalize Content

There are also times when you generally refer to things from your own culture and expect others to know about it – unless you tell them about it. I’ve celebrated Ganesh Chaturthi ever since I was a child. But, to hear that this is a festival to celebrate the birth of the elephant-headed good was still weird for me. Still, the additional information helped my colleague explain our UK counterparts on what the festival was about.

Piecemeal Editing in the Agile Environment

In the Agile development environment, the technical reviews and technical edits aren’t exhaustive. The editors do not have a lot of time to repetitively (Or, at least more than once) run through the writing process. So, all they get to do is check for not missing out on anything critical.

Why Isn’t a “Help” Helpful Enough?

For the most part of their exploring the product, the users are busy finding answers to their how-does-this-damned-thing-works questions. Why is it still that we are unable to design formats that can make the users’ troubleshooting pursuits easy?

Don’t Fix What Isn’t Broken!

We all learn. And, here’s the post on one such thing I learned, recently. For one of the projects I worked before I switched jobs last week, I was the only tech-comm contributor who held the dual role of preparing technical content as well as marketing collateral for the flagship product. Until that time, I thought that technical writing made me be proud of one habit of pursuit: Perfection. I have grown, learned

The Ad hoc Content Writer

This month has been really exciting for me at the office. That’s because, from the first day, I played only a technical communicator. But in this month, I added some more feathers to my tech-comm cap – Newsletter and Blogs! I delivered a big project at the start of this month: Administration, installation, and user guides; a CHM help; and a couple of utility documents. And, all that as the

What questions do you ask to SMEs to begin with technical documentation?

During a recent online conversation, someone requested for a list of questions I would typically ask to a subject matter expert (SME) to prepare technical documentation for a topic. Of course, the parameters may vary, but there is still a list of questions that apply across all sizes or complexities of projects. In this post, I share with you the list of questions that I shared with them…

TechComm and Content Disruption

Vinish Garg recently posted on the content’s role in Disruption. In his post, he shared what the experts had to say on the role that content has to play/currently plays. Here’s my opinion: What is Disruption? Let me first take you back in time. This started when the marketing and branding industry opened the corporate gates to the world of consumers. And, by opening the gates, I mean it transformed

Do you create video reviews on newer technologies, too?

Time and again I get to answer the question about what I do for a living. Yes, it does get irritating at times. But, mostly I love answering such questions. This time around, it was a marriage party and the questions were from the father of a curious teenager. “So, I heard you are a writer!” Is that a question? No, he knows that I am a writer. It’s just

The Next Big Thing: Workshop

Next month, I am conducting a couple of workshops at the STC India Annual Conference, in Pune. I like to talk about technical communication. And, at the conference, I’ll meet a lot of those would like to talk to me about this faculty of knowledge. Also, information design, as a topic, has always fascinated me. And, this time, I am conducting the workshops on the same topic. In one of

Categories

Subscribe to Blog via Email

Enter your email address to subscribe to this blog and receive notifications of new posts by email.

Join 668 other subscribers

Marked as ‘Read’ on Goodreads

© 2020 The Wordsmith . Theme by Viva Themes.
google.com, pub-2035719743358482, DIRECT, f08c47fec0942fa0