Comments for The Art of Technical Communication

Comment on Technical Communication as Literature by admin

admin — Wed, 28 Jul 2010 13:11:24 +0000

Mark, I agree with you that bi-directional communication is highly important for developing relevant documentation; but, by itself, it’s not enough - the writer still needs to provide an organized framework of information with recognizable themes and emphasis, including some kind of conceptual framework whereby the information becomes meaningful. This is especially important where you have a very small community of users - perhaps for a new product that hasn’t yet “caught on”. Without a vast user community that can contribute lots of insights, information, and feedback, solid, engaging technical literature becomes essential - even if it’s essentially “one-way”. In fact, a really good manual or tutorial can help inspire and create an enthusiastic user community.
Once a user community reaches a critical point in size, as well as in professional expertise, the “documentation” is then increasingly influenced by the community itself - eventually, leaders emerge in the community who contribute insights, suggestions for improved product design, improved documentation, etc. The feedback from such a large group is more reliable and becomes a valuable source of information for users, product managers, and developers.
Besides all of the above, technical literature plays an important role in the marketing of the product as well - but that’s another topic…

Comment on Technical Communication as Literature by Mark Fidelman

Mark Fidelman — Tue, 15 Jun 2010 07:17:13 +0000

I’m not sure how we can “engage” the reader when we are providing one way communication. What’s needed are tools that enable the Technical Communicator to have a bi-directional discussion with the customer in order to get their valuable feedback and documentation requirements.

Comment on Technical Communication as Literature by Techquestioner

Techquestioner — Tue, 04 May 2010 18:10:59 +0000

I had a “Literature of Science” course in college, where we read and discussed writing that advanced scientific knowlegde. The examples I remember 40 years later are Michael Faraday’s “Chemical History of a Candle,” a translation of Newton’s “Pricipia,” and Watson and Crick’s article on the double-helix structure of DNA.

I believe that some well-designed, well-writen documents that serve the users of the products they explain can qualify as “Technological Literature”. Those kinds of documents, which may win awards, provide examples for others to emulate, and contribute to the adoption of new technology. We need more of those that transcend the minimum informational requirements.

Regardless of the authors’ aspirations, not all novels become best-sellers, and not all best-sellers will ever be considered “Literature” either.

Comment on Should We Call it Technical Communication? by admin

admin — Tue, 20 Apr 2010 04:27:50 +0000

“Effective Communication” sounds exactly right! Thanks for that suggestion - so now I should rename this blog “The Art of Effective Communication”.

Comment on Should We Call it Technical Communication? by Techquestioner

Techquestioner — Mon, 19 Apr 2010 17:57:25 +0000

How about “Effective Communication”? The “technical” nominally refers to the “technical” subject matter. All communications need to be effective, regardless of the subject matter.

Comment on Time Flies When You’re Writing by Techquestioner

Techquestioner — Mon, 19 Apr 2010 17:54:31 +0000

This is another apt descrption of the state referred to as “Flow”, that many writers and artists aspire to reach. It’s a great feeling to experience, and afterward, you tend to have accomplished a lot more than you usually would in the same period of time. The real trick is learning how to get yourself into that creative state more often, or “on demand” when you need to make a deadline.

Comment on Putting the Cart Before the Horse by Witurs

Witurs — Wed, 12 Aug 2009 08:13:57 +0000

Very good selection of interesting and educational posts! Excellent!

Comment on The Art of Technical Communication by Andre L

Andre L — Sun, 30 Nov 2008 20:08:36 +0000

Heya…

Looking for something else, but fine website. Thank you….

Comment on Jabberwock by AlexM

AlexM — Tue, 12 Aug 2008 23:18:58 +0000

I found your site on technorati and read a few of your other posts. Keep up the good work. I just added your RSS feed to my Google News Reader. Looking forward to reading more from you down the road!