[Zope-dev] Documentation Tool Requirements

Stephan Richter SRichter@ixl.com
Thu, 19 Aug 1999 11:13:32 -0500


hey Zopesters,

I originally posted this message to the ZDP list, but I thought some of you
guys may have some great input too. 

So, here you go. What I am looking for are requirements like features,
usability, workflow, user levels and many other things that you would like to
see in the new FAQ, Tutorials, How-To's and Reference Manual. 
The first two main tools will be FAQ and the Reference Manual. These will be
implemented first.
Here is the format (XML) you should send the requirements in:
<category title="title">
      <abstract>
            Structured Text describing the category (not neccessary if the
            category already exists.
      </abstract>

      <entries>
              <entry title="title of entry">
                  <status>Requirement captured</status> 
                  <rating>1-10</rating>
                  <name>Your name</name>
                  <abstract>
                          Please describe your requirement in structured text. I did not
                          write renders for html tags. 
                  </abstract>
              </entry>
        </entries>

</category>

The responses I got so far you can see at:
http://www.zope.org:18200/Members/srichter

PLEASE DO NOT SEND RESPONSES TO THE ENTIRE LIST SO WE DO 
NOT FILL UP MAILBOXES.
I will post the results every night. Please do not reply with requirements on
the mailing list in normal text format, since it will take me forever to
extract them and put them into the proper format. Let's see how strong the
community can be.

THANK YOU ALL FOR YOUR INPUT.

regards,
stephan
--
Stephan Richter
iXL - Software Designer and Engineer