Re: Requirements for Documentation System

From: Date: Mon, 12 Apr 2004 23:53:14 +0000
Subject: Re: Requirements for Documentation System
References: 1  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3295@lists.php.net to get a copy of this message
Hi, all,
Add new requirement: Ability to preview the edited document (perhaps multiple times) before saving or committing it.
Indeed that will be useful. We already have a solution in the works: Livedocs. I have experimented doing this with Livedocs and works well for editing needs.
So you agree with the requirement? Jesus, man, your accomplishments are fantastic, far beyond mine*, but we want to avoid reference to specific implementations here. We are not doing DocBook or LiveDocs apologetics, we're doing requirements listing. Please, agree or disagree with a requirement, add/change/delete one, but I ask that you refrain from talking about specific implementations and their various promises or failings until the requirement listings are done. * For those of you who have not seen it, check this out:
    http://www.zend.com/comm_person.php?id=9
Add new requirement: Ability to distinguish between versions of a document. (This kind of folds into the "roll-back" requirement.)
Yep, and that's what a versioning control system brings to the process. Be it CVS, Subversion or even good old RCS, tech solutions exists and are in place (cvs.php.net). So that part of the requirements is more or less fulfilled.
So you agree with the requirement? Again, we're not talking about fulfillment or not, we're talking about requirements listing.
Agree, PEARDOC stands as it is because it was an effort that evolved from the experience of PHPDOC. Making a change in the system will need more than just a set of requirements, will need a "sit down and code it" approach no matter what changes are planned.
Correct, but first we need to figure out what we want, and then we can bring solutions to bear. -- Paul M. Jones pmjones@ciaweb.net Savant: the simple alternative to Smarty. http://phpsavant.com/

« previous php.pear.doc (#3295) next »