Web Writing That Works!

           A Project of
           The Communication Circle

Guidelines Rants Patterns Poems Services Classes Press Blog Resources About Us Site Map

HomeRants > How to organize a step-by-step procedure. > A group of procedures can be a reusable object



 

A group of procedures can be a reusable object

If you find you are writing hundreds of procedures, or your team is churning out a few thousand, you begin to notice that you keep repeating yourself.  You need to refer to, or reprint whole sets of procedures.

Back in the days when we wrote books, we would put those procedures in their own chapter, and then, whenever we needed to have people do those, we would say, "Go see Chapter 5 for info on how to do this!"

Online, we can invoke the set of procedures electronically, so, in effect, we can repeat ourselves ad infinitum. 

If you need to invoke a certain group of procedures over and over, create a new element that points to all of those procedures.  That's a reusable object.

Example: When telling people how to use your MP3 player, you may discover that you keep referring to a series of procedures called Using Your MP.  You need to point to those procedures in your sections on Media Tools, Sound Tools, and Bundled Applications.   Here's how you might diagram the reuse.

 

Instead of including a cross reference at the end of a section, then, you could simply provide a link taking people to this group.  In turn, the group might just be a menu, taking people to the individual procedures, as needed. 

 

Was I supposed to shave before or after brushing?

 

Home | Guidelines | Rants | Patterns | Poems | Services | Classes | Press | Blog |
Resources | About Us | Site Map

Web Writing that Works!
http://www.WebWritingThatWorks.com
  2002-2004 Jonathan and Lisa Price
The Communication Circle
Discuss at HotText@yahoogroups.com
Email us directly at ThePrices@ThePrices.com
Order Hot Text (the book) from Amazon