How to write a manual?

No, the question mark is not a mistake.  I have been trying to write a procedures manual and trying to write a training manual for student assistants and it is a PITA.  If anyone has any ideas, I’m open.

About these ads

One Response to “How to write a manual?”

  1. Kirsten Says:

    Have you looked at other libraries’ comparable documents? That might help. Why write something from scratch when you can just borrow it? ;-)

    My former workplace has some examples here:
    http://www.ecok.edu/library/information/students/information.asp

    FWIW, my own opinion is to keep things short and to-the-point. Break everything down into little-bitty steps for the procedures manual — that way they’re easier to follow (especially if someone’s in a hurry or flustered).


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Connecting to %s

Follow

Get every new post delivered to your Inbox.

%d bloggers like this:
http://kittent.wordpress.com/2009/06/09/how-to-write-a-manual/
kittent.wordpress.com
crawl=CC-MAIN-2013-20
46708
application/http; msgtype=response
sha1:4HOMLGYROCCHYYXSNHOIVF7AGMK3D6JD
<urn:uuid:563e1feb-dcc7-44d0-a967-07711a77cdcd>
2013-06-19T09:18:00Z
72.233.2.58
sha1:OETSWSE3WAERCAXURELU7CONDSJYUJN3
<urn:uuid:f06bffa8-bc71-4c23-9b39-07da5e3b3a69>
http://kittent.wordpress.com/2009/06/09/how-to-write-a-manual/
response
<urn:uuid:85c31213-74bf-49a7-9ae9-2724ad28176c>
robots: classic
hostname: ip-10-60-113-184.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2013-20
operator: CommonCrawl Admin
description: Wide crawl of the web with URLs provided by Blekko for Spring 2013
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf