Web Writing That Works!

           A Project of
           The Communication Circle

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

HomePatterns > How to articulate concepts > Define classes hierarchically.


 

 

Define classes hierarchically.

When the concept is a class of objects, and you are describing that class for programmers, you may want to answer questions such as:

  • What is this class?
  • How can I spot a member of this class? 
  • Can you show me an example?
  • To what superclass does this belong?
  • What classes are components of this one?
  • Can you give me some advice about using this class?
  • What libraries contain applets using this class?

Open the concept up by sorting the information out into a series of objects like this. The pattern helps the user get fast access to particular information, skipping the irrelevant or unimportant. 

When created as XML elements, these objects let individuals pick and choose, personalizing their own definitions.

Resource

Creating customer assistance that actually helps, from Hot Text: Web Writing that Works (2002, PDF, 993K, or about 18 minutes at 56K)

Personalizing the class definition

When you label each of these components with XML tags, distinguishing each one, you make it possible for individuals to select the components they like, hiding or rejecting the others.  Here are two examples of personalized class definitions.

 

 

 

Exactly what is the concept?

 

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