[ZDP] Keywords and Categories: Discussion based on Use Cases

Maik Roeder roeder@berg.net
Thu, 09 Mar 2000 18:55:44 +0100


Hi !


I will try to put together all that has been discussed 
about keywords and categories.

The problem is: A problem with the present doc is finding
                the relevant information. Lots of docs are
                already available but you have to browse a
                lot to find the information.

1. Use Case: Visitor Search

A visitor searches for a word like "ZCatalog" to find some good
resources on this topic. The search results into too many "hits"
to be able to find out which of these are relevant.

2. Use Case: Display FAQ-Questions sorted  by category

There are many questions in one FAQ section, and it would make 
sense to order them according to a common category.

3. Use Case: Display Snippets sorted by category

There are many Snippets in one SnippetFolder, and it would make
sense to order the Snippets contained in them by a certain
category.

4. Use Case: "What's related" search

A visitor may have found a resource in the ZDP which answers
some of his questions. He would like to further explore ZDP,
but instead of searching directly, which most people would
do, he makes a search for what's related. This search is
performed using keywords.

5. Use Case: "More about" search 

A visitor has found a good resource on ZCatalog. He now wants
a list of all other resources which have the same category/topic.

The "What's related" and "More about" searches could be made
a standard 'builtin' hyperlink feature, as Tom has proposed.

Implementation:

In the Add Forms, we add a select list to pick keywords and 
categories. Keywords and Categories are going to be drop-in
ZClasses. 

The drop-in ZClasses would be used for keeping a sorted list
of keywords and categories. In a FAQ for example, the
Questions could be grouped in a section such as DTML. So, 
we have:

FAQ Folder: Has property "category=General"
Category Folder "General": Defines general categories like "DTML"
                           sorted somehow
FAQ Section: category DTML
Category Folder "DTML": Defines categories for the topic DTML
                 sorted somehow.
FAQ Question: Contains one of the category

Keywords Folder "General": Defines a set of standard keywords like "ZCatalog"
Snippet Folder: Has property "keywords=General"
Keywords Folder "ZCatalog": Defines keywords for the topic ZCatalog
Snippet: Has property "Keywords=ZCatalog"

Categories:
   DTML
   * syntax
   * variables
   * tags
   Security
   * roles
   * permissions
   * passwords
   * authenticated_user
   external methods
   python methods
   argument passing
   content manipulation
   python products
   acquisition 
   zsqlmethods

6. Use Case: Add FAQ Question with existing keywords

The user wants to add a FAQ Question. He has the possibility to add
some keywords to them. The keywords are picked from the list 
provided by the dropped in Keywords folder.

7. Use Case: Add FAQ Question with new keywords

The user is not satisfied with the existing keywords and wants
to add his own. To do this, he first has to go to the Keywords
Folder, and enter the new keywords there. Then he has to go 
back and add the keywords to the Question he originally wanted
to post.
Alternative: The user just enters the new keywords, which are
automatically added to the Keyword Folder.

Any ideas ?

Greetings,

Maik Röder