cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Diana Shannon <terrac...@mac.com>
Subject Re: --- Help with document classification ---
Date Fri, 26 Apr 2002 13:50:58 GMT

On Friday, April 26, 2002, David Crossley wrote:

>
>>    | -----  FAQ Document -----|
>>
>> Purpose
>> Addresses holes or ambiguity in docs, bugs in code.
>
> Has many pruposes. Also is something that gets asked frequently.
> Some things are so fundamentally hard to grasp, or so commonly
> misunderstood. This is not due to deficiency in any doco. This
> type of FAQ remains forever.
>
>> Provides a quick
>> (though not always the best) way to update docs.
>
> I am not sure what you mean here.

Well, sometimes it's more expedient to add an extra FAQ item than it is 
to edit an existing how-to, guide, etc.

>> Architectural issues
>> This document class might grow quickly. Shouldn't we treat specific FAQ
>> content as separate documents? If so then we'll need a revised faq.dtd
>> (as per Forrest) and stylesheet(s) as well as search/grouping
>> functionality before the size grows unwieldy. Individual FAQs need 
>> "last
>> modified" content.
>
> The non-usability of the long FAQ as one single document
> with Cocoon 1 was a real turn-off. I got frightened when i saw
> the state of that document.
>
> Are you suggesting a separate document for each Question?

Yes.

> Sounds interesting. In that way, FAQ listings could be drawn
> together to form various topics.

Potentially, if managed carefully. In other words, I wouldn't want to 
encourage lots of some tangential FAQ contributions for the sole purpose 
of filling holes in desired topic tracks/maps. Have you seen this 
implemented anywhere?

Diana


---------------------------------------------------------------------
To unsubscribe, e-mail: cocoon-dev-unsubscribe@xml.apache.org
For additional commands, email: cocoon-dev-help@xml.apache.org


Mime
View raw message