[OPEN-ILS-GENERAL] Writing an Evergreen manual

[Murphy, Sally]

Good idea, but lets wait on that until we have something started,
documentation-wise, before gettin' all crazy.  I don't know about you,
but I tend to stall when projects get too much cool, but ultimately
peripheral, tasks added to them.  And documentation really shouldn't
stall any more.  I'd be happy if we just had a sample up and a
documented procedure for submitting documentation.  

 

An Evergreen committer should, of course, have final say over how we go
about submitting pieces to the manual, otherwise, I'd go ahead and put
those instructions I suggested up on the Wiki.  Either way, though, I'd
really like to get started on some manual-writing, so let's get on this
thing! =)

 

-Murph

 

 

Some say the world will end in fire and ice.  Others say it will be
segfaults.

 

-----Original Message-----
From: open-ils-general-bounces at list.georgialibraries.org
[mailto:open-ils-general-bounces at list.georgialibraries.org] On Behalf Of
Etheridge, Jason - Gmail
Sent: Tuesday, October 09, 2007 12:15 PM
To: open-ils-general at list.georgialibraries.org
Subject: Re: [OPEN-ILS-GENERAL] Writing an Evergreen manual

 

On 10/9/07, Murphy, Sally <smurphy at georgialibraries.org> wrote:

> Also, what kind of support does doc books have for graphics, and
formatting

> pages with them?  Focusing on end-user stuff, there will be lots of

> screenshots, diagrams of menus, pictures of icons, and such.

 

Thinking along those lines, it would be great if the documentation

framework could optionally alert folks when there are pertinent

changes to the source code.  For example, if you have a screenshot of

the Item Status staff interface, perhaps the framework could associate

it with an RSS feed of the changelog for the corrresponding XUL and

CSS files, and flag anything that might require a new screenshot

(maybe we could require that commiters embed a magical keyword into

the changelog like DOC_UPDATE_NEEDED).  If a documenter doesn't know

anything about internals, then no biggie, just no magic until someone

else comes along and adds the pertinent meta-data.

 

Or am I overthinking this and it would just be too complicated to get

something like that working? :)

 

-- 

Jason Etheridge

 | VP, Community Support and Advocacy

 | Equinox Software, Inc. / The Evergreen Experts

 | phone:  1-877-OPEN-ILS (673-6457)

 | email:  jason at esilibrary.com

 | web:  http://www.esilibrary.com

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://list.georgialibraries.org/pipermail/open-ils-general/attachments/20071009/7087968b/attachment-0001.html