register | login
  search
Contact Us    News    Blog    Events    Careers    Customers    Employees
You are Here:  ResourcesBlog
Click Here to Get You Copy Today! MindTouch Most Influential Techcomm
 
Follow us on Twitter    Join us on Facebook    Follow us on YouTube    Link to us on LinkedIn

Blog
31

The salt of the earth

I just came across this, and I love it. It's from the introduction to an HTML5 Handbook, written by Stefan Münz on the German-language "web competence" site.

On the Internet, technical documentation is the salt of the earth. Without documentation there is no Internet - because the techniques and technologies would remain isolated, bound in people's heads, never shared and quickly forgotten. Documentation is therefore the written culture of the Internet and the basis for the Internet's stability.

(The translation is mine, and so is the blame for any errors or misinterpretations.)

We talk a lot about the value of technical communication, but I've never seen it stated in such bold terms.

There is technology. But without technical documentation, the technology exists in isolation -- and eventually dies -- because it's locked inside someone's head.

There is technology. But without technical documentation, the technology goes to waste because nobody knows how to use it.

Technical documentation and, I like to think, the people who produce it, are the salt of the earth. This morning, that puts a little extra spring in my step and gives me a renewed sense of purpose for my work.

How about you? What do you think of Mr. Münz's statement about the value of technical documentation?

About the Author

Larry Kunz

Larry Kunz is a project manager and information architect with SDI with more than 30 years’ experience as a writer, manager, and planner. He has experienced the transition from book-based documentation to today's integrated delivery of information both as a writer and a manager. Larry is a Fellow in the Society for Technical Communication (STC) and in 2010 received the STC President’s Award for leading the Society's strategic planning effort.


Posted in: Global Solutions
Recent Related Articles:

Review: The Insider's Guide to Technical Writing - If you're a new or aspiring technical writer, you deserve a reward. And I know just the thing: The Insider's Guide to Technical Writing by Krista Van ...

Down to the river: Structured authoring immersion - Mollye Barrett must've spent time in the South. During her STC Summit presentation on the content lifecycle, the Milwaukee-based content-management ex...

STC Summit 2013: Content in a mobile world - On more than one occasion I've gotten up from a conference session or a webinar and thought, "That was really good information. I remember first heari...

STC Summit 2013: Early impressions - Many others are tweeting and blogging about the STC Summit, now in its second day. Here are a few of my impressions. ►I'm thrilled to see so many fir...

Why we love David Pogue - A "mutual lovefest" is how New York Times technology columnist David Pogue described his first STC Summit keynote speech, in 2009. His encore performa...

« Back | |
Comments:
Colum McAndrew
Friday, August 31, 2012 10:23 AM
Like you Larry I like that quote. There is an arguement that documentation prolongs the existence of knowledge and maybe even propogates it. After all without Neolithic man drawing on the walls of his cave or Egyptian hieroglyphics we'd know a whole lot less than we do about those people and their culture. Why wouldn't the same apply to the Internet?
Mark Baker
Friday, August 31, 2012 10:32 AM
It's a great quote, Larry, but it may perhaps be conflating the value of the RFC process, which is how most engineering knowledge about the Web is shared, with end user manuals. Both may be valuable, but the Web would survive the absence of the latter.
Dawn Baird
Friday, August 31, 2012 11:40 AM
I totally agree. Technical Writing is much more than specifications, wikis, help files and guides. It's to be found in websites who sell technical products and services from many industries, not just the IT one.

Yes, I'm a Technical Writer. :)
Milan Davidović
Friday, August 31, 2012 1:13 PM
And to what extent are we conflating "people who produce [technical communication]" with specialist technical communicators?
Larry Kunz
Friday, August 31, 2012 1:32 PM
@Colum and @Dawn - Thanks for stopping by, and thanks for your words of support.

@Mark - Your point is valid, and I readily concede that "technical documentation" in the original quote doesn't equate to user manuals and help. Nevertheless, someone is producing all of that ocumentation. As @Milan asks, is that "someone" just the development community and the user community? Or does it also include professional technical communicators?

As technical communicators, we need to ask ourselves whether we're content with a narrow role -- merely producing end-user instructions -- or whether we ought to become contributors, and even leaders, in the work of producing documentation in the broader sense.
Milan Davidović
Friday, August 31, 2012 2:09 PM
I'm not inclined to believe in an overall "ought to". A context-specific "how well is this process working?" seems a more interesting starting point.
Anonymous User
Friday, August 31, 2012 2:46 PM
http://everypageispageone.com/2012/08/31/wide-world-of-tech-comm/
Dawn Baird
Friday, August 31, 2012 2:54 PM
Larry, in my experience, we need to become more flexible in creating technical content wherever it is needed. The opportunities for technical writers are endless, whether we concentrate on one industry or not. I think the skill of rendering understandable all types of technical information is one that will become more and more sought after as our tech-focused world continues to invent, develop and innovate.
Vinish Garg
Tuesday, September 04, 2012 11:38 AM
Communication is the core of how a man evolved from an individual to society. Technical Documentation is an extension to general communication in the society. Communication was primarily about (a) sender (b) receiver (c) medium (d) message. Technical documentation has added more dimensions such as (e) clarity (f) how much (g) timing (h) pitch (i) respect (j) completeness (k) accuracy, and few others! And we take extreme pride to have this skill to communicate within these parameters, effectively.

Vinish (http://www.enjoytechnicalwriting.com)
Keisha
Friday, May 10, 2013 11:23 AM
viagra >:-)) cheap car insurance :OOO auto insurance quotes 9680 auto insurance pry nj car insurance %-)) auto insurance quotes lyqkp
Post Comment

Name (required)

Email (required)

CAPTCHA image
Enter the code shown above:

    

Home  |  About Us  |  Services  |  Solutions  |  Resources
ISO9001 Certification NC & Budapest | privacy statement | terms of use | site map Copyright by Systems Documentation, Inc. | Follow us on Twitter Join us on Facebook Follow us on YouTube Link to us on LinkedIn