Re: Requirements for Documentation System
| From: | Paul M Jones | Date: | Tue, 13 Apr 2004 01:27:26 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 2 3 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3300@lists.php.net to get a copy of this message | ||
On Apr 12, 2004, at 7:17 AM, Alan Knowles wrote:
+ Tool to convert existing work done in docbook into system X... * we have quite a large documentation base already in docbook (although some is little more than stubs created by phpdocu...)If we do convert anything, then yes, this will have to be there. It may not be necessary, but if it is, it's a requirement. Add new requirement: a way to automate conversion of extant documentation into the system.
+ Doc generation tools have large userbase, and are maintained... * So when someone looses interest in maintaining the system X => HTMLHow is this: "The system itself must be well-documented and open to shared maintenance."Convertor we hare not left hanging..
From what I have seen - the Wiki->docbook idea that paul has, seems vaugly workable.. - but I do suspect that like I found with OO<->docbook, it may have some serious flaws.. (especially on round tripping..)There are certain to be flaws in just about anything. Wiki->DocBook might be nice, but it might not fit all the requirements. We might even end up with parallel systems: one for on-the-fly editing, and one for the "official" build of the documentation. We can figure all that out as we continue. :-) -- Paul M. Jones pmjones@ciaweb.net Savant: the simple alternative to Smarty. http://phpsavant.com/