Re: Requirements for Documentation System
| From: | Jesus M. Castagnetto | Date: | Tue, 13 Apr 2004 01:01:04 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3296@lists.php.net to get a copy of this message | ||
My mistake, should've been more clear.
--- Paul M Jones <pmjones@ciaweb.net> wrote:
> 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?
Yes, I do think that constant feedback to a
documentation author is a good thing. Not sure about
continuous (live) documentation _publication_, there
should be delay from when documentation is commited to
when it appears on-line, just to account for
errors/defacing/etc., which can be corrected timely if
(for example) there is (for example) a day lag between
a commit and it appearing on-line.
[... snip ...]
> >> 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?
Yes, I do. (Guess the 'yep' was too short :-) Being
able to revert problematic changes is a good thing in
my book.
[... snip ...]
> > 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.
Yep. Looking forward to the most current list after
all the discussion.
It is good to have someone like Paul that can keep us
on track.
Cheers.
=====
--- Jesus M. Castagnetto <jmcastagnetto@php.net>
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com