CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site
This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Proposed Documentation Plan
Pages: [1]

Author Topic: Proposed Documentation Plan  (Read 1845 times)

FatherShawn

  • Ask me questions
  • ****
  • Posts: 372
  • Karma: 25
    • C3 Design
  • CiviCRM version: 4.2.11
  • CMS version: Drupal 7.23
  • MySQL version: 5.5.32
  • PHP version: 5.3.10
Proposed Documentation Plan
November 10, 2011, 11:56:42 am
This thread is for discussion of the documentation plan proposed in my blog post.
« Last Edit: November 10, 2011, 12:00:10 pm by FatherShawn »
Lead Developer, C3 Design.
Twitter: @FatherShawn

Dave Greenberg

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 5760
  • Karma: 226
    • My CiviCRM Blog
Re: Proposed Documentation Plan
November 15, 2011, 03:15:57 pm
Shawn - I'm trying to squeeze in time to update or add pages wiki pages covering new or significantly changed features / functionality as I'm QA'ing 4.1 release issue tracker items. I'm doing this on the 4.1 wiki documentation space (http://wiki.civicrm.org/confluence/display/CRMDOC41). I'm wondering if it makes sense for myself and others to create a list (or somehow flag) the wiki pages that are being updated??
Protect your investment in CiviCRM by  becoming a Member!

Dave Greenberg

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 5760
  • Karma: 226
    • My CiviCRM Blog
Re: Proposed Documentation Plan
November 15, 2011, 04:24:59 pm
Actually, after a quick chat with Michael McAndrew I think it makes more sense to document stuff that "belongs" in the User and Admin Guide directly there using the book editing interface and skip the redundant work :-). The "assumption" is that the next "release" of the FLOSS book will be applicable to 4.1.
Protect your investment in CiviCRM by  becoming a Member!

FatherShawn

  • Ask me questions
  • ****
  • Posts: 372
  • Karma: 25
    • C3 Design
  • CiviCRM version: 4.2.11
  • CMS version: Drupal 7.23
  • MySQL version: 5.5.32
  • PHP version: 5.3.10
Re: Proposed Documentation Plan
November 16, 2011, 08:05:34 am
Agreed - as part of that I had proposed that we cross-index by adding links to the wiki to http://wiki.civicrm.org/confluence/display/CRM/2011+CiviCRM+user+and+administrator+guide+review.  The idea is to figure out which wiki pages are already covered in the book, pull in any missing tidbits and then prune the wiki...
Lead Developer, C3 Design.
Twitter: @FatherShawn

Dave Greenberg

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 5760
  • Karma: 226
    • My CiviCRM Blog
Re: Proposed Documentation Plan
November 18, 2011, 10:23:34 am
Ok cool. Alice and I also discussed the need to have some other eyeballs review the latest edition of the book for accuracy and relative completeness (i.e. given the functions addressed, that there's no gaping holes). I'm sending out an email (text below) reaching out directly to some folks that I think might be able to help (and who have strong content knowledge). Hopefully that will flush out some more reviewers / potential doc team members.

Anyone reading this who is interested in helping with the review, please add your name to a section on the wiki page:
http://wiki.civicrm.org/confluence/display/CRM/2011+CiviCRM+user+and+administrator+guide+review
Protect your investment in CiviCRM by  becoming a Member!
Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Proposed Documentation Plan

This forum was archived on 2017-11-26.