The Macrosite for News, Analysis and Opinion about the Future of the Internet
Mary E. Shacklett

How Digital Documentation Can Work for IT

3/15/2012 34 comments
no ratings
DISCUSS     Email This

The Encyclopedia Britannica isn’t the only trusted hardcopy to go digital. More technical support and best-practices are being relayed to IT professionals through cyber-based documentation, while paper manuals continue to fade.

But as this happens, IT workers are challenged to navigate technical information for troubleshooting and problem resolution.

The problems with cyber-based documentation are not substantially different than they were with standard paper-based documentation. “I find that online resources, especially from vendors whose equipment I work with on a daily basis, are extremely helpful,” said one financial services company network administrator. “I can sign onto a Microsoft help site or a network expert Website for troubleshooting and find all kinds of solutions for a given situation I am trying to resolve. However, I have to know enough about what I am looking for to gain from the information—or it’s not going to help.”

The situation is common. It presents a two-fold challenge: 1) how to build your own “personal experience base” so you can approach cyber-technology research already knowing what you’re looking for; and 2) how to develop your documentation and Website research skills so that you can quickly locate the information that you need.

First, let’s talk about creating the personal experience knowledge base. This is a major issue for beginning and mid-level ITers, who require time on the job to build experience. Nevertheless, they can accelerate the process if they enter their careers with an already-developed conceptual understanding of how everything fits together (networks, systems, software, etc.).

Conceptual overviews are not usually taught onsite by company subject matter experts (SMEs), unless the company has an IT training program (which some large enterprises have). So overviews are usually the task of colleges and universities.

Companies recognize, of course, that schools (and even the Internet) cannot carry the educational load alone. This has prompted many organizations to implement internal knowledge bases that their own technicians can access through either the Intranet or Internet. These knowledge bases document IT problems and resolutions, so that hopefully the next person tasked with a similar problem can cut resolution time through research.

Naturally, there are pitfalls, too.

One problem can be the platform or application for the knowledge base. It may be tough to give this the IT attention it requires, resulting in snags. “We began developing a knowledge base over the past few years, and it was very helpful for me as a new IT employee at the help desk,” said one IT professional at a national research center. “However, the cloud-based system that we implemented for the knowledge base did not work very well. We were always encountering bugs in it. But the knowledge base still did help me in my daily responsibilities of supporting one thousand users.”

The second main problem with online documentation may be a lack of ability on the part of technicians to perform the research required to get the answers they need. There appears to be some evidence that students are no longer arriving at companies with the research skills they had in the past. Some experts believe this reflects a relaxation of grading and study skill standards and colleges and universities.

At least one university takes a different approach. “We believe that research is an essential part of technical learning in our IT curriculum, and we include the effective reading and research of technical documentation as part of the skills that we teach,” said one Chinese university official I spoke with this year.

Here's hoping more teachers follow that path.

Related posts:

— Mary E. Shacklett, President, Transworld Data

DISCUSS     Email This
Current display:       newest comments first       display in chronological order
Page 1 of 4   Next >
Mr. Roques
Researcher
Tuesday August 28, 2012 3:00:23 PM
no ratings

Well, accepting a contract for which you are not qualified for is a little unsettling... they made a decision based on false information?

abdlah
IQ Crew
Monday April 30, 2012 6:26:25 PM
no ratings

Will have Ms. Mary Jander give you my email.

Mary E. Shacklett
Thinkernetter
Monday April 30, 2012 3:17:21 PM
no ratings

Great. Would like to keep in touch on Africa. Do you have email address? 

abdlah
IQ Crew
Monday April 30, 2012 12:37:24 PM
no ratings
I used to teach full-time at the United Arab Emirates University. Now, I am a private consultant in Ghana.
Mary E. Shacklett
Thinkernetter
Monday April 30, 2012 12:16:56 PM
no ratings

Well said,  Abdlah.

I wish more teachers would do  this.

Where are you teaching?

abdlah
IQ Crew
Monday April 30, 2012 10:53:15 AM
no ratings

Properly designed documentation would definitely be useful.

abdlah
IQ Crew
Monday April 30, 2012 10:39:25 AM
no ratings

Since an experience during my MBA where my professor took accepted a contract and turned around to confess to me that he did not have the skills required for doing the job but that he was confident of doing it since he knew how to find people who could help him do it (he was going to use Internet Forums and groups), I have taken a key interest learning how to search online.

I have also made sure that I teach my students that if they learn nothing at all from my class, they should understand how to find what they need via appropriate fora on the net.

Mr. Roques
Researcher
Thursday March 22, 2012 10:39:25 AM
no ratings

I believe being able to efficiently search the document is also very important. We might think adding tons and tons of information is valuable. But its not until someone tries to find a solution, that we find out what a headache it is to find it.

WaqasAltaf
IQ Crew
Tuesday March 20, 2012 10:38:11 AM
no ratings

@ Syedzunair

Yes, I agree with you. I was eyeing more towards professional designers, architects and other professionals dealing in production of high graphic products. For them, its difficult to work on a standard-size screen for tablet.   

Mary E. Shacklett
Thinkernetter
Monday March 19, 2012 9:07:19 PM
no ratings

Since  I spend a lot of my time in front of an LED screen all day--I prefer real paper at night (like   doc, or a real  book)! :)

Page 1 of 4   Next >
The ThinkerNet does not reflect the views of TechWeb. The ThinkerNet is an informal means of communication to members and visitors of the Internet Evolution site. Individual authors are chosen by Internet Evolution to blog. Neither Internet Evolution nor TechWeb assume responsibility for comments, claims, or opinions made by authors and ThinkerNet bloggers. They are no substitute for your own research and should not be relied upon for trading or any other purpose.
previous posts from Mary E. Shacklett
Mary E. Shacklett
The average yearly tuition cost for brick-and-mortar colleges and universities in the US today is more than $20,000, an expense that has increased 1,120 percent since 1978. By comparison, students of all ages can often earn an online education for one fourth of this annual cost -- and more businesses are starting to acknowledge online degrees.
Mary E. Shacklett
Social media has indelibly changed the way we think about community and collaboration. Diminishing IT budgets are having a similar effect.
Mary E. Shacklett
Technology facilitates the virtual office -- but is that all there is to it?
Mary E. Shacklett
The datacenter collocation market is estimated to grow to 32.2 billion dollars by 2015.
most recent post: Mary E. Shacklett... It's really a tough one to call at this point, DHagar!
Mary E. Shacklett
Telesurgery has come a long way since surgeons made the first virtual incision more than 12 years ago. But impediments still remain.
5
of
Mitch Wagner
'Digital Nomads' Work From Anywhere & Everywhere

2|14|13   |   2:35   |   20 comments


New tools like laptops, tablets, smartphone, and wireless connectivity let us work from San Diego to Katmandu, and anywhere in between. But time management remains a problem.
Mary Maida
How Medtronic Overcomes Social Business Resistance

1|31|13   |   1:23   |   No comments


Showing results is the best way to win over social business doubters, according to Mary Maida, Medtronic lead information solutions manager. Internet Evolution's Mitch Wagner interviewed Maida at the E2 Innovate conference.
Alison Diana
Striking a Balance for Website Upgrades

1|24|13   |   1:59   |   3 comments


Companies need to take advantage of new technologies to simplify interfaces, improve capabilities, and enhance back-office processes. But they can't upgrade their Websites too often.
Kelli Carlson-Jagersma
Wells Fargo Sales Get Social Business Boost

1|16|13   |   2:30   |   2 comments


Wells Fargo uses social software to replace email chains and help its sales team collaborate more effectively to land deals, according to Kelli Carlson-Jagersma, VP Collaboration Strategy for Wells Fargo. Mitch Wagner spoke with Carlson-Jagersma at the E2Innovate conference
Wisdom of the Big Chair
Price, Not Features, Driving Smartphone Sales

11|29|12   |   2:01   |   7 comments


A survey by JD Powers found that customer interest in product features is lessening as phones evolve. Rather than features, price is driving purchases, and that change could have a dramatic impact on how IT departments secure these devices.
Reiter's Block
Enterprises Kick In to Help During Disasters

11|8|12   |   3:12   |   2 comments


Businesses helped neighbors with Internet access and mobile device charge-ups during Sandra. Following that example, enterprises should consider preparing Internet disaster plans to help the public during disasters.
Mitch Wagner
Confessions of a BYOD Hypocrite

11|8|12   |   2:35   |   No comments


BYOD is a bad idea, yet even a dedicated opponent finds it inescapable.
Mitch Wagner
TweetDeck Gets a Second Life

11|5|12   |   9:54   |   13 comments


A recent release of the popular TweetDeck app for Twitter power-users gives new life to software that had previously taken a wrong turn. Here's a quick walk-through of the new TweetDeck, to show you why it should be at the top of your Twitter toolkit.
Mary E. Shacklett
Don’t BYOD to the Internet of Things

9|10|12   |   2:46   |   10 comments


The bring-your-own-device approach isn’t suited to monitoring of enterprise equipment and processes. In these cases, it is up to IT to come forward with gear suited to the task.
Reiter's Block
IT Should Evaluate On-Screen Keyboards

7|19|12   |   3:01   |   9 comments


On-screen keyboards are getting a lot more complicated, and IT departments should consider evaluating them.
IETV: the thinkerNet on film
5
of
Kim Davis
Big-Data Can’t Always Sell Wine

5|21|13   |   2:23   |   3 comments


Whole Foods Global Wine Purchaser Doug Bell told me about some of the constraints on using analytics in the US wine market.
Paul J. Fleuranges
Digital Signage Keeps NYC Subway Straphangers on Track

5|6|13   |   3:51   |   No comments


New York's Metropolitan Transit Authority is conducting a pilot test of digital kiosks to guide subway users to where they want to go more efficiently and at lower cost.
Kim Davis
Fast Forward to the Future

4|23|13   |   2:29   |   20 comments


A look back at tech writing in the 90s makes us wonder where enterprise IT will be 20 years from now.
Mitch Wagner
Google Launches Its Most Depressing Service Yet

4|15|13   |   2:59   |   10 comments


Google's new Inactive Account Manager lets you control how Google disposes of your accounts when you die.
Second Shooter
Argument Over Top-Level Domains Is 'Stupid'

4|11|13   |   2:07   |   3 comments


The whole Amazon.reader debate is a double-stupid. It's stupid to think that there's any e-book buyer who doesn't know Amazon's URL, and it was stupider to let ICANN launch the whole free-form TLD initiative to start with.
Kim Davis
Ladies, Your Tablet Awaits

3|21|13   |   2:22   |   37 comments


ePad Femme is the world’s first tablet “made exclusively for women.”
Wisdom of the Big Chair
NFC Moves Into the Mainstream

3|20|13   |   2:16   |   No comments


While NFC's original goal was to enhance mobile commerce applications, it is finding its way into a number of other uses, which is creating both opportunity as well as challenges for IT departments.
Wisdom of the Big Chair
Integrating Security Into Your Cloud Contract

3|19|13   |   3:35   |   No comments


Enterprises would like to move to cloud computing but are hesitant because they are concerned about providers’ ability to secure company data. Here are some tips that help to ensure that if breaches occur, the business is not left holding the bag.
Brian Baron
How Edmunds.com Collects Customer Information

3|18|13   |   1:15   |   No comments


Edmunds separates customers into segments based on the info it collects on its site and from partners, and uses that to push out custom content, said Brian Baron, director of business analytics for Edmunds.com, at Predictive Analytics Innovation Summit.
Brian Baron
How Edmunds.com Uses Analytics to Customize Site

3|14|13   |   0:47   |   No comments


The automotive website uses propensity modeling to target ads and customer registration forms, said Brian Baron, director of business analytics for Edmunds.com, at Predictive Analytics Innovation Summit.
an IBM information resource
sponsored content
big blue blog
Alison Diana
Ushering in a new era of cognitive computing systems, IBM announced today the IBM Watson Engagement Advisor, a technology breakthrough that allows brands to crunch big data in record time to transform the way they engage clients in key functions such as customer service, marketing, and sales.
an IBM information resource
sponsored content
Expert Integrated Systems: Changing the Experience & Economics of IT
In this e-book, we take an in-depth look at these expert integrated systems -- what they are, how they work, and how they have the potential to help CIOs achieve dramatic savings while restoring IT's role as business innovator.

READ THIS eBOOK
your weekly update of news, analysis, and
opinion from Internet Evolution - FREE!

REGISTER HERE
Wanted! Site Moderators
Internet Evolution is looking for a handful of readers to help moderate the message boards on our site – as well as engaging in high-IQ conversation with the industry mavens on our thinkerNet blogosphere. The job comes with various perks, bags of kudos, and GIANT bragging rights. Interested?

Please email: moderators@internetevolution.com
Internet Evolution – not for thickies
Keep Critical Data With a Knowledge Management System
Taimoor Zubair
Fortune 500 companies lose at least
$31.5 billion a year by failing to share knowledge. A Knowledge Management System (KMS) can help companies significantly reduce these costs.

CLICK FOR MORE
Yahoo Needs to Break Tumblr in Order to Fix It
Joe Stanganelli
As
Mitch Wagner discussed today, Yahoo is acquiring Tumblr. The big Internet debate at the moment is whether Tumblr will be good or bad for Yahoo. Regardless of their stances on the future of Yahoo itself, many claim that Yahoo will somehow ruin Tumblr.

CLICK FOR MORE