forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Diana Shannon <terrac...@mac.com>
Subject documentation architecture?
Date Thu, 25 Apr 2002 12:20:19 GMT
Is it within the scope of Forrest to offer projects suggested 
mechanisms/approaches/templates/schema for documentation? For example, 
let's say a project had the following documentation offerings.

documentation categories
- FAQs
- mini how-tos
- guides (e.g., component-oriented)
- tutorials
- examples/cookbook "recipes"
- case studies
- reference guides
- quick-reference guides

For example, you may want to have:
- "What's New" page within each documentation category
- "Features" page (any document category)
- Ability to search/browse within each documentation category as well as 
across all documentation categories, based on content, last modified 
date (thanks David Crossley).
- Dataset scalability mechanism (e.g., when number of how-tos files 
grows too large)
- Contributor's info (instructions/info, author/edit guidelines, 
how-tos, schema)

Also, does Forrest's FAQ dtd (with all FAQ elements in a single file) 
properly anticipate processing/administering large numbers of FAQs, 
particularly when you factor in potential community contributions?

Is it within the mission of Forrest to implement/provide these items? If 
not, I apologize for the noise.

Thanks.

Diana


Mime
View raw message