I like Cheryl's suggestion! It would be nice to know if something has already been edited before investing much time into reviewing it. It would also be a nice way to watch our progress and keep moving towards our goal of getting everything documented and edited.
Jenny ============================== Jennifer Turner PALS, A Program of the Minnesota State Colleges and Universities Minnesota State University, Mankato ML 3022 Mankato, MN 56001 507-389-2000 * Through Our Work, Knowledge Grows * -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Cheryl Gould Sent: Monday, August 16, 2010 12:51 PM To: [email protected] Subject: [OPEN-ILS-DOCUMENTATION] noting what sections need content - in outline or in docs I'd like to second Robert's suggestion that there be a quick reference option on the outline page for looking at what sections need more documentation and then maybe what sections need editing. I'm wondering if on the outline we can do a few things with color/bolding or italics to make it quick to view. I'm thinking something like: names of contributors are in italics Sections that need content are written in red text sections that need editing are in yellow text sections that have been edited are in green text. Alright, I realize this could be a little messy but it would be quick to see what's going on in each section of the documentation. We could agree that the main headings and sections stay black and bold so it's quick to scan until ALL subsections have been edited...if that ever happens ;) Cheryl Date: Wed, 11 Aug 2010 13:09:39 -0400 From: "Soulliere, Robert" <[email protected]> Subject: Re: [OPEN-ILS-DOCUMENTATION] how to mark up text to indicate need for review or extension ? To: Documentation discussion for Evergreen software <[email protected]> Message-ID: <cea75392dddf7b479a1d4d5bb73ff1d20fa17ef...@mcfe-140-ex001.mc.local> Content-Type: text/plain; charset="us-ascii" 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 _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation _______________________________________________ OPEN-ILS-DOCUMENTATION mailing list [email protected] http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
