Solved

Where Can I find a software training template?

Posted on 2009-05-13
2
1,090 Views
Last Modified: 2012-05-06
Hi,

One of the software developers on the team developed a very complicated tool and I'd like to write the training documentation for our users and I can't seem to find any templates around this.

Anyone have any good templates I can use? I don't want to spend the time thinking about the table of contents.

here is what I was thinking of though:
> Break it the application by each "feature". For each feature, talk about the inputs, raw functionality, and outputs.
> Provide WF documentation and for each item in the workflow, write a couple lines about it.
> maybe even write the physical "steps" of traversing through each item and even providing screenshots.

I'd like a more structured approach however. Let me know!
0
Comment
Question by:piyushdabomb
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
  • 2
2 Comments
 
LVL 45

Accepted Solution

by:
patrickab earned 500 total points
ID: 24393273
piyushdabomb,
If the application is that complicated, apart from a training manual you should also have a proper on-line Help system created with something like helpMatic which you can obtain from:
http://www.helpmatic.net/
 If you have written an on-line system, adapting it to create a training manual should be a straightforward task.
Patrick
0
 
LVL 45

Expert Comment

by:patrickab
ID: 25354078
piyushdabomb - Thanks for the grade - Patrick
0

Featured Post

Comprehensive Backup Solutions for Microsoft

Acronis protects the complete Microsoft technology stack: Windows Server, Windows PC, laptop and Surface data; Microsoft business applications; Microsoft Hyper-V; Azure VMs; Microsoft Windows Server 2016; Microsoft Exchange 2016 and SQL Server 2016.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

This guide will walk you through the essential considerations and tech stack for building scalable websites. Know how to grow your business the smart way!
This post contains step-by-step instructions for setting up alerting in Percona Monitoring and Management (PMM) using Grafana.
This Micro Tutorial will demonstrate in Microsoft Excel how to add style and sexy appeal to horizontal bar charts.
With the power of JIRA, there's an unlimited number of ways you can customize it, use it and benefit from it. With that in mind, there's bound to be things that I wasn't able to cover in this course. With this summary we'll look at some places to go…

751 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question