Select to view content in your preferred language

Designing instruction manuals

2352
2
07-25-2011 04:00 PM
MichelleLewis
Deactivated User
Hello everyone,

We will be going live with our GIS information soon. At some point in the near future, I'm going to need to create a user manual which will describe how to go from receipt of the original data to manipulation of that data to fit our criteria and then to production.

Do any of you know where I might be able to find a real or example copy of something like this to use as a template/idea generator? I know I'll need to make it specific to us, but I'd really rather not reinvent the wheel; if it's already out there, I'd prefer to use a design that works.

Thanks - Michelle
Tags (1)
0 Kudos
2 Replies
MarkEllis
Emerging Contributor
Any luck with this yet?  We have thorough SOPs that you could maybe look at for ideas.  However, you are right that the content would need to be replaced in its entirety.  Some questions to ask before you get too far:

1) Must the manual describe dummy-proof steps and settings, or more general terms?  Is it to be used as a step by step guide for new techs?

2) Should the manual avoid command/tool specifics in order to remain relevant with software changes?  That is, are conceptual steps or detailed tool settings more important for this document?

3) Is project history or context relevant to the document?  A user who needs to know the big picture will call for more information that is not part of processing steps.

Other things are sure to be included, such as layers, field definitions, and the like.
0 Kudos
MichelleLewis
Deactivated User
Thank you! No, no luck yet, but you've given me great ideas on how to start. 🙂
0 Kudos