Re: Requirements for Documentation System
| From: | Paul M Jones | Date: | Mon, 12 Apr 2004 23:00:01 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3290@lists.php.net to get a copy of this message | ||
On Apr 12, 2004, at 5:48 PM, Stefan Neufeind wrote:
On 13 Apr 2004 at 0:36, Cipriano Groenendal wrote:With aAgreed. Let us say we are talking about a trusted team, as per the above paragraph describing the PEAR-DEV problem. Are we OK for "instantly" under that assumption?5. Fast turnaround between edits and displayed results.roll-backin place, this would be a Good Thing(TM) yes. ...
Oh, in that discussion I see a small problem: Instant updating versus versioning. Imho instant updating while editing should be restricted to a "Preview"-button, and clicking on "Save" should be avoided until reasonable changes have undergone - otherwise we would end up with multiple versions just for adding a word and then thinking it might just be better to remove it again or something :-))Add new requirement: Ability to preview the edited document (perhaps multiple times) before saving or committing it. Add new requirement: Ability to distinguish between versions of a document. (This kind of folds into the "roll-back" requirement.)
Sorry, this mail was about techniques (CVS) - but I think we should already consider if we can use the existing backend somehow, or if it really needs replacement.It's OK (this time! ;-). You bring up an important concept about this process. The idea here is *not* to bash the current system. There are certain to be good and wonderful things about the current state. The point here is to find out what we need. Then, after we have the "perfect list" we can propose solutions, everything from "scrap it all" to "modify in-place" to "keep it as it is." Nobody has actually done a requirements list, so everybody has their own idea of how things should be. If we can agree on a set of goals, we can have a common framework for discussion on how to reach those goals. Now, back to requirements! :-) -- Paul M. Jones pmjones@ciaweb.net Savant: the simple alternative to Smarty. http://phpsavant.com/