Social Business Discussions Are The New Documentation - InformationWeek

InformationWeek is part of the Informa Tech Division of Informa PLC

This site is operated by a business or businesses owned by Informa PLC and all copyright resides with them.Informa PLC's registered office is 5 Howick Place, London SW1P 1WG. Registered in England and Wales. Number 8860726.

IoT
IoT
Software // Social
Commentary
11/21/2013
08:06 AM
Dennis Pearce
Dennis Pearce
Commentary
50%
50%

Social Business Discussions Are The New Documentation

Social business is changing how we document business processes and IT operations. Here's why.

When I was much younger and bought a new radio, TV, or VCR, the first thing I did was read the manual cover-to-cover so I could understand how the thing worked. This was easy to do because most tools and electronic devices had a single function, which usually equated to a relatively short and simple manual.

But today, when you buy devices like these, you also get remotes with about 30 or 40 buttons on them that all require manuals. My car comes with multiple thick manuals, too, including one just for the navigation system. And most software documentation is deceiving: You never really see the pages piled up on top of each other; you just get lost in a labyrinth of links as you jump across topics that are supposedly related.

As products become more feature-rich, their documentation becomes longer and more complex. As a result, it has the perverse effect of conditioning users to skip reading it altogether. When I get a shiny new car, smartphone, or TV, the last thing I want to do is spend a week reading the documentation before I use it. Instead, I just dive right in using the basic features and learn over time about the bells and whistles by trial and error, dipping into the documentation for a specific reference, searching for an answer on the web, or just asking somebody.

[ Do you have a long-term perspective? Read Picturing Your Social Business In 2020. ]

Inside an organization, the problem is often the opposite -- there's too little documentation, not too much. Think about your process for ordering office supplies or having your laptop updated: Most internal tools and business processes are poorly documented, if at all. Some are legacy systems whose creators are long gone. Some are ad hoc systems that were thrown together on the fly but worked so well that they've gradually become business critical. How many of you use "Bob's spreadsheet" or "Mary's monthly report"? (It's a dead giveaway when the tool has a personal name associated with it.) And none of them have information developers assigned to fully document their capabilities.

But how does this all relate to social business? In the past year, I've noticed how helpful our social software vendor's customer community site has been in answering questions. I'm not talking about how others respond to questions I might post -- although that's also been a very useful feature -- but rather the large collection of content that has built up over time.

Documentation isn't what it used to be, thank goodness. (Source: Flickr user acaben)
Documentation isn't what it used to be, thank goodness.
(Source: Flickr user acaben)

When I have a question about their software, I bypass their documentation (sorry, tech writers!). The first thing I do is go to the community and type in some search terms. More often than not I find the answer to my question, and it's in a discussion rather than in a more formal document. Some of these discussions have spanned months and sometimes years, giving me context and nuance to the answer that I just couldn't get otherwise. For example:

"I have question X."

"Here's the answer."

"Well, that's true in most cases but if you have this configuration then you need to do Y." (Oh hey, that's my situation!)

When employees work out loud in a transparent social platform, they are documenting their tools and processes on the fly as they build them. Documentation is no longer the extra work that no one wants to do; it's a natural, inherent part of the process. As an added bonus, you often get an explanation of why something works the way it does, not just how.

There will always be a place for formal documentation, especially with commercially available products. But the complexity of those products and our behavior as consumers are pushing us toward a model that favors discussions over documents. And especially inside the firewall, as social business progresses and more employees begin working out loud, organizations may find that with a good search engine and a little bit of tagging they can document many of their tools and processes for free. What do you think?

There's no single migration path to the next generation of enterprise communications and collaboration systems and services, and Enterprise Connect delivers what you need to evaluate all the options. Register today and learn about the full range of platforms, services and applications that comprise modern communications and collaboration systems. Register with code MPIWK and save $200 on the entire event and Tuesday-Thursday conference passes or for a Free Expo pass. It happens in Orlando, Fla., March 17-19.

We welcome your comments on this topic on our social media channels, or [contact us directly] with questions about the site.
Comment  | 
Print  | 
More Insights
Comments
Newest First  |  Oldest First  |  Threaded View
David F. Carr
50%
50%
David F. Carr,
User Rank: Author
11/21/2013 | 11:50:17 AM
For technical writers, too
This trend is absolutely relevant to the technical writers who do documentation, who have also had to adapt their work. See this column from a couple ofhears ago.

How Social Media Changes Technical Communication - InformationWeek http://www.informationweek.com/social-business/wikis/how-social-media-changes-technical-commu/232301245 via @InformationWeek
David F. Carr
50%
50%
David F. Carr,
User Rank: Author
11/21/2013 | 9:31:19 AM
Re: Intranets & internal social networks are key
Kristin, I couldn't agree more. I've always found it hard to really absorb technical instructions in the abstract, whether it's how to use a device or how to work with a programming language. Once I've painted myself into a corner and really need the information, that's when I go look it up. Community resources are great for that kind of just in time information. Of course, to be a good community member, you ought to give back some discoveries of your own from time to time.

That's what it's all about!.
Kristin Burnham
IW Pick
100%
0%
Kristin Burnham,
User Rank: Author
11/21/2013 | 8:48:20 AM
Intranets & internal social networks are key
I hate reading instruction manuals. Whenever I have a question about why something stopped working or when I see an error message, I always Google it. And inevitably what pops up first: Similar questions -- and solutions -- on user forums.

The applications of something similar in the workplace are just as useful: Have a question? Skip the email in which you CC everyone and search for the answer on your intranet. If your company has an internal social network, use that to ask the question or search for the answer. You'll likely find it quickly, and without cluttering everyone's inboxes.
InformationWeek Is Getting an Upgrade!

Find out more about our plans to improve the look, functionality, and performance of the InformationWeek site in the coming months.

News
Remote Work Tops SF, NYC for Most High-Paying Job Openings
Jessica Davis, Senior Editor, Enterprise Apps,  7/20/2021
Slideshows
Blockchain Gets Real Across Industries
Lisa Morgan, Freelance Writer,  7/22/2021
Commentary
Seeking a Competitive Edge vs. Chasing Savings in the Cloud
Joao-Pierre S. Ruth, Senior Writer,  7/19/2021
White Papers
Register for InformationWeek Newsletters
Video
Current Issue
Monitoring Critical Cloud Workloads Report
In this report, our experts will discuss how to advance your ability to monitor critical workloads as they move about the various cloud platforms in your company.
Slideshows
Flash Poll