CREATING END USER MANUALS - May 24th, 2012


This section of the CMSB cookbook focuses on the needs of the end user, the folks who will use our designs and the CMSB
interface on a daily basis.

The most important advice that I can offer to a designer who is writing a document for an end user is to never assume
prior knowledge on the part of the end user. Assume that they have extremely little computer knowledge and that because
of this, they will take you instructions very literally and will be reticent to make any changes for fear of
“breaking” something.

After you’ve written the manual, and after you’ve tried to follow your own instructions, have a layperson (or a
small focus group of lay people) try to follow the instructions and give you feedback about where they had problems.
Then adjust the document accordingly before releasing it to the public.

If at all possible, try not to use the “it” word. It is the one word in technical manuals that leads to more
confusion than almost any other.

I’ve included a copy of an end user manual that was written (using the WYSIWYG editor) for an association that had a
number of members assigned to update specific pages on their web site. Your particular client’s needs will be
different but this material should provide you with a jumping off point to provide your clients with effective end user
instruction documents.

I've also included all the files necessary for an end user manual that uses a multi-record editor and text boxes. Among
the advantages are automatic formatting of chapters, main topics and sub topics and the ability to list all new ad
revised entries at the top of the page for a period o 30 days.



The materials on this web site have been created for use with CMS Builder content management software. CMS Builder software is published and licensed for use by InteractiveTools.com. Please contact Interactive Tools for information on the downloading of the software or the purchasing of licenses.


Terms of Service