By using this site, you agree to the Privacy Policy and Terms of Use.
Accept
SmartData Collective
  • Analytics
    AnalyticsShow More
    predictive analytics in dropshipping
    Predictive Analytics Helps New Dropshipping Businesses Thrive
    12 Min Read
    data-driven approach in healthcare
    The Importance of Data-Driven Approaches to Improving Healthcare in Rural Areas
    6 Min Read
    analytics for tax compliance
    Analytics Changes the Calculus of Business Tax Compliance
    8 Min Read
    big data analytics in gaming
    The Role of Big Data Analytics in Gaming
    10 Min Read
    analyst,women,looking,at,kpi,data,on,computer,screen
    Promising Benefits of Predictive Analytics in Asset Management
    11 Min Read
  • Big Data
  • BI
  • Exclusive
  • IT
  • Marketing
  • Software
Search
© 2008-23 SmartData Collective. All Rights Reserved.
Reading: Capturing Knowledge, and Making in ‘Transferable’ (3 of 4)
Share
Notification Show More
Latest News
ai software development
Key Strategies to Develop AI Software Cost-Effectively
Artificial Intelligence
ai in omnichannel marketing
AI is Driving Huge Changes in Omnichannel Marketing
Artificial Intelligence
ai for small business tax planning
Maximize Tax Deductions as a Business Owner with AI
Artificial Intelligence
ai in marketing with 3D rendering
Marketers Use AI to Take Advantage of 3D Rendering
Artificial Intelligence
How Big Data Is Transforming the Maritime Industry
How Big Data Is Transforming the Maritime Industry
Big Data
Aa
SmartData Collective
Aa
Search
  • About
  • Help
  • Privacy
Follow US
© 2008-23 SmartData Collective. All Rights Reserved.
SmartData Collective > Uncategorized > Capturing Knowledge, and Making in ‘Transferable’ (3 of 4)
Uncategorized

Capturing Knowledge, and Making in ‘Transferable’ (3 of 4)

Jim MacLennan
Last updated: 2010/06/13 at 3:42 PM
Jim MacLennan
12 Min Read
SHARE

Classroom teaching doesn’t scale …

We’ve talked about the importance of training material, and ways to make it “findable”. The next level of “active laziness” is to build material that doesn’t require the Subject Matter Expert’s presence to be effective. Need to train 100 people in 10 states – all within one week? You need to move past PowerPoint, and learn to create teaching material that is “transferable”.

More Read

Ease-of-use Key to Successful Business Intelligence Deployments

Jack Bauer and Enforcing Data Governance Policies
Are Links A Distraction?
Riptano for Cassandra

Learn From Experience (ie. Copy What Works)

The first attributes that all documentors must develop are large amounts of humility, empathy, curiosity, and a willingness to try new things.

  • Experiment – Many in IT are downloading software, spinning up home servers, and buying all sorts of gadgets and software for home, personal, and business use. Especially with consumer goods, there is a significant amount of design expertise in the construction of the training manuals and on-line help – you should know, because you have been using them!
  • Curiosity – Have you ever thought about how these products, systems, applications, and processes are put together to make them easy to use? And, when required, just the right amount of documentation is provided? …

Classroom teaching doesn’t scale …

We’ve talked about the importance of training material, and ways to make it “findable”. The next level of “active laziness” is to build material that doesn’t require the Subject Matter Expert’s presence to be effective. Need to train 100 people in 10 states – all within one week? You need to move past PowerPoint, and learn to create teaching material that is “transferable”.

Learn From Experience (ie. Copy What Works)

The first attributes that all documentors must develop are large amounts of humility, empathy, curiosity, and a willingness to try new things.

  • Experiment – Many in IT are downloading software, spinning up home servers, and buying all sorts of gadgets and software for home, personal, and business use. Especially with consumer goods, there is a significant amount of design expertise in the construction of the training manuals and on-line help – you should know, because you have been using them!
  • Curiosity – Have you ever thought about how these products, systems, applications, and processes are put together to make them easy to use? And, when required, just the right amount of documentation is provided? After you are done with that new video game, ponder a moment how the publisher has successfully made the software easy to use. And don’t stop there – examples of effective communication to modify behavior are all around us (directional signs, aisles and lanes in amusement parks, food packaging). Take time to deconstruct how these communications are “put together”.
  • Empathy – While observing things, take the next step back, and watch how other people are interacting with the same thing. Can you see how the product designer adds arrows, call-outs, and colors to keep people from making the same mistake as the last guy did? Don’t limit your thinking to your own style of working with stuff – anticipate what other folks might be thinking.
  • Humility – Some time after leaving college, I got over my delusions of center, and started noticing how so may ideas are just riffs on stuff that has preceded it. Sure, the true artists among us are creating the wild and new, and yes, I have a certain amount of pride of authorship in all that I do. However, I’m never above stealing a better idea or method; when I am documenting or training stuff, the objective is transfer the knowledge to lots of people.

In addition, a little bit of laziness helps. You really need to get all 100 people up to speed, but you should not allow for (or rely on) personal training sessions to get the job done. Wouldn’t it be easier to just write it once, and have everybody read the manual and get to work? This needs to be your goal – write it, distribute it, forget it. The hard working folks that decide “extra TLC” means hand-holding all of their end users through the new process will burn tons of time and energy doing truly repetitive work; personal attention doesn’t scale.

With those thoughts in mind, here are some methods and tools that will help …

Templates – Capturing Best Practices for Documentation

I like copying previous work, but I don’t like to copy previous documents – I will only see the thought that went into that particular piece of training material. With a document “template”, I can lay out a fairly generic outline, and add instructions, notes, things to think about, and step-by-step instructions. I have previously written about my generic project charter; each time I tee up a new project, I don’t have to remember what has worked in previous project charters, I just iterate on a proven model. (Note: If I get enough requests, I will publish the generic version, complete with instructions and sample text).

The key for any template like this is that it is a document that has been proven to work – to effectively communicate what I need. The real power is that it is a compendium of “best practices” – each time I use it, I add refinements and/or more examples of effective text to the template, so my next charter will be more “brilliant” (and, easier to construct) than the last.

Note – don’t confuse this with MS Office Document Templates. I love the idea, but in all of the companies I have worked with and for in the past, very few Office users understand how to use Document Templates.

HyperText – Oh, How the Mind Wanders

Of course, with electronic help (like blogs, wikis, and even the classic Windows Help System), hypertext is a powerful way to add in-context supporting information. Need to provide an abbreviation or expound a bit on a supporting concept? Hypertext – “hot links” to supporting details – are a great help. As a Reader, you know how this stuff works – now, as a Writer, you need to understand how to construct these connections. This also takes a hefty dose of Empathy – you need to get into the mind of your audience, anticipating the problems and/or questions they may have – and add a bit of HTML to take them where they [might] want to go.

Hypertext has certain analogs in the printed paper world – like an index in the back of a book, or the call-outs and margin asides that are featured in so many … for Dummies books.

Anticipate Multiple Consumption Methods

CSS allows us to separate presentation from content – this let’s me focus on the content and not worry about how it will be consumed. Fine – but you must reverse that focus as well, and pay just as much attention on the multiple ways that potential trainees will want to consume this stuff. I’m not just talking about creating multiple delivery mechanisms; you also need to think about how your training material will lay on paper, in a browser, on a projected screen … on a smartphone … through a translator …

You also need to think about letting folks know that this knowledge exists, and how to keep informed when updates and additions exist. One of the nice native features of SharePoint is the ability for users to subscribe to eMail alerts or RSS feeds. Of course, you must assume that folks are subscribing, so any and all changes to the applications, business process, or training material have to be documented, and then a change notice sent out.

Sneaky Tactics to Assure Scalability

Especially with new systems, new processes, and new consumption methods, I like to invest face-time with some early adopters. It’s like beta-testing software – a reasonably small number of representative users are given more TLC than should be necessary, because you need to validate your assumptions about the effectiveness of the training material. To be sure – you should really say nothing, offer little help – in the end, the training material needs to stand on it’s own.

Still, you will probably not get it 100% right – so embed a two-way, feedback-enabled sensibility in your training documentation, by adding contact information. If nothing else, it will act as a security blanket for your end users – and, if you put your cell phone number there, added incentive to make the training material extra-effective (so you don’t have to take the calls).

Previously …

A “New” Critical Requirement for Business Projects
As we continue the deep dive into questions like “how do I get information required to run my business?”, we inevitably get to training …

Capturing Knowledge, and Making in ‘Findable’
If the training material is difficult to locate, and people can’t find it to use it – it might as well not exist.

Next …

Calculating the Business Benefit of Effective Training Material
So where is the business benefit? How can I go from “obvious idea” to tangible business ROI?


Questions? Comments? Suggestions? Send mail to webmaster at cazh1 dot com
© Jim MacLennan for cazh1, 2010. |
Permalink |
2 comments |

 

Link to original post

Jim has over 20 years experience in a progression of roles in corporate IT, translating the strategic drivers of a variety of business models and markets into tactical plans and tangible results. His career spans multiple industries, including real estate / property management, building construction and maintenance services, pharmaceuticals, consumer durables, and consumer package goods.

 

TAGGED: css, documentation, scalability
Jim MacLennan June 13, 2010
Share this Article
Facebook Twitter Pinterest LinkedIn
Share
By Jim MacLennan
Follow:
Jim MacLennan is Senior Vice President and Chief Information Officer at IDEX Corporation, a Fortune 1000 manufacturer that sells highly engineered products in a variety of markets worldwide. MacLennan has responsibility for Corporate IT services for all IDEX business units, and also drives innovation through initiatives that leverage Information and Technology as growth drivers for the industrial manufacturing space. He regularly publishes his observations and insights on the intersection of business and technology - check out his work at www.cazh1.com.

Follow us on Facebook

Latest News

ai software development
Key Strategies to Develop AI Software Cost-Effectively
Artificial Intelligence
ai in omnichannel marketing
AI is Driving Huge Changes in Omnichannel Marketing
Artificial Intelligence
ai for small business tax planning
Maximize Tax Deductions as a Business Owner with AI
Artificial Intelligence
ai in marketing with 3D rendering
Marketers Use AI to Take Advantage of 3D Rendering
Artificial Intelligence

Stay Connected

1.2k Followers Like
33.7k Followers Follow
222 Followers Pin

You Might also Like

Ease-of-use Key to Successful Business Intelligence Deployments

10 Min Read

Jack Bauer and Enforcing Data Governance Policies

14 Min Read

Are Links A Distraction?

4 Min Read

Riptano for Cassandra

5 Min Read

SmartData Collective is one of the largest & trusted community covering technical content about Big Data, BI, Cloud, Analytics, Artificial Intelligence, IoT & more.

ai in ecommerce
Artificial Intelligence for eCommerce: A Closer Look
Artificial Intelligence
AI and chatbots
Chatbots and SEO: How Can Chatbots Improve Your SEO Ranking?
Artificial Intelligence Chatbots Exclusive

Quick Link

  • About
  • Contact
  • Privacy
Follow US

© 2008-23 SmartData Collective. All Rights Reserved.

Removed from reading list

Undo
Go to mobile version
Welcome Back!

Sign in to your account

Lost your password?