[pmwiki-users] Building the 2.1.0 documentation

Patrick R. Michaud pmichaud at pobox.com
Fri Mar 10 07:00:56 CST 2006

On Fri, Mar 10, 2006 at 12:00:42AM -0500, Neil Herber wrote:
> At 2006-03-09  12:13 AM -0600, Patrick R. Michaud is rumored to have said:
> >It's also a good idea to be familiar with the documentation guidelines
> >at http://www.pmwiki.org/wiki/PmWiki/DocumentationGuidelines .
> >
> >If there are any questions, feel free to put them in the pages
> >or ask the list.  If something needs my specific attention, just
> >put it in the [[!Update me]] category or send an email.
> Note that the suggested markup for incomplete docs 
> on  http://www.pmwiki.org/wiki/PmWiki/DocumentationGuidelines  is 
> [[!DocumentationToDo]] .
> Should this be changed to [[!Update me]] or should we use both?

My initial thought is that we should use both -- my original
conception of [[!Update me]] was that it's targeted to me personally
(as in "This needs Pm's direct attention").  [[!DocumentationToDo]]
would be a note to just anyone.

OTOH, [[!Update me]] could become a useful convention that many
sites could use and that would extend beyond just the PmWiki 
documentation, so perhaps it's a meme we could try cultivating 
and see what happens.

Perhapse [[!Update me]] is a bit more imperative, while
[[!DocumentationToDo]] just becomes a note that more work
needs to be done on the documentation but it's not likely to
happen immediately.

For now, let's change [[!DocumentationToDo]] to [[!Update me]]
in the guidelines, and see what happens.  I can convert [[!Update me]]
to [[!DocumentationToDo]] as appropriate.



More information about the pmwiki-users mailing list