[OPEN-ILS-DOCUMENTATION] Helping with documentation

Ryan Laverdiere ryan484lav at msn.com
Tue Oct 28 14:29:27 EDT 2008


I think that the video I did is great now it's just a matter of getting them on the website.

Thanks,
Ryan
  ----- Original Message ----- 
  From: Karen Schneider<mailto:kgs at esilibrary.com> 
  To: Public Open-ILS documentation discussion<mailto:open-ils-documentation at list.georgialibraries.org> 
  Sent: Monday, October 27, 2008 7:41 PM
  Subject: Re: [OPEN-ILS-DOCUMENTATION] Helping with documentation


  This is a nicely-done video -- short and sweet and to the point. 

  Last week George Duimovich of  NRCan Library / Bibliothèque RNCan shared some thoughts about user-contributed documentation. He pointed to an example for PostgreSQL: 

  http://wiki.postgresql.org/wiki/Main_Page<http://wiki.postgresql.org/wiki/Main_Page> 

  This might be an approach to Evergreen, as well. Right now the main wiki page is all over the map. Ryan's videos would fit nicely under "Community Generated Articles, Guides, and Documentation" in a video tutorial subcategory. It wouldn't get lost in the flotsam and jetsam currently cluttering the wiki at this point. 

  Note that last week I added a particularly nice PR brochure here: http://evergreen-ils.org/dokuwiki/doku.php?id=advocacy:pr<http://evergreen-ils.org/dokuwiki/doku.php?id=advocacy:pr>

  I just uploaded a file and linked to it (on the assumption that this file would be somewhat immutable and no other approach was warranted). (Yes, we had permission :) ) 

  Oh, and this is cramming yet another thought into this message, but I've been looking at DocBook and some earlier messages of Dan's (plus input from George) and thinking hard about this as an overall approach to Evergreen documentation. 

  (See esp. http://open-ils.org/dokuwiki/doku.php?id=documentation:history_of_the_technical_writing_project&s[]=docbook<http://open-ils.org/dokuwiki/doku.php?id=documentation:history_of_the_technical_writing_project&s[]=docbook> )

  I think he's right, and the issue is how to get there. Right now we're focusing on generating a lot of documentation, and that's fine. From talking to documentation writers I know from here and there, many of them write in Word and then convert to a doc-authoring format. By mid-December I hope to turn to the issue of organization and presentation and to also focus on getting the mess that is the wiki in some seemly order.

  -- 
  -- 
  | Karen G. Schneider
  | Community Librarian
  | Equinox Software Inc. "The Evergreen Experts"
  | Toll-free: 1.877.Open.ILS (1.877.673.6457) x712
  | E-Mail/AIM: kgs at esilibrary.com<mailto:kgs at esilibrary.com>
  | Web: http://www.esilibrary.com<http://www.esilibrary.com/>
  _______________________________________________
  OPEN-ILS-DOCUMENTATION mailing list
  OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
  http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20081028/96e655ec/attachment-0001.htm 


More information about the OPEN-ILS-DOCUMENTATION mailing list