[OPEN-ILS-DOCUMENTATION] how to mark up text to indicate need for review or extension ?

[Soulliere, Robert]

I wonder if this can be done outside of the document in a quick outline for quick reference so that we can quickly see what gaps exist in the documentation without getting into the document. I've been trying to make notes on the official outline:
http://evergreen-ils.org/dokuwiki/doku.php?id=evergreen-docs:outline but this could get messy very quickly especially when you get into particular missing paragraphs or small sections. I wonder if a more extensive outline for notes should be created for more extensive notes?  If your working with a particular group, leaving inner document notes like you suggest and then letting other members of the group or team know the gaps that need to be filled in works as well. Notes can also be added when submitting it to the github repository if that is an option.

I don't think a policy or standard was set for this. I suppose this might become more important as more people become involved.

Thanks,
Robert





________________________________________
From: open-ils-documentation-bounces at list.georgialibraries.org [open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of steve sheppard [ssheps at gmail.com]
Sent: August 11, 2010 12:37 PM
To: open-ils-documentation at list.georgialibraries.org
Subject: [OPEN-ILS-DOCUMENTATION] how to mark up text to indicate need for      review or extension ?

All,
[I don't recall seeing this in previous discussions -- maybe I've missed it?]

Any ideas on how best to mark up parts of our work that need further review or extension?
I currently add place-holder sections like the following to indicate that further discussion / expansion is needed on a subject:

          ...stuff that precedes
          <para> [[how to determine which version of PostgreSQL you have]] </para>
          ...stuff that follows

What do you think?

--Steve



This E-mail contains privileged and confidential information intended
only for the individual or entity named in the message.  If the reader
of this message is not the intended recipient, or the agent responsible
to deliver it to the intended recipient, you are hereby notified that
any review, dissemination, distribution or copying of this communication
is prohibited.  If this communication was received in error, please
notify the sender by reply E-mail immediately, and delete and destroy
the original message.