[OPEN-ILS-DOCUMENTATION] Suggestion: increase use Launchpad for DIG purposes (reporting doc errors, missing docs)

[Kathy Lussier]

Hi Yamil,

We discussed this a bit at today's meeting, but I just wanted to add my 
send my opinion to the list too. I would like to try tracking 
documentation needs through Launchpad. We've tried a number of ways to 
track our needs. We have the wiki outline and the spreadsheet that was 
created at last year's DIG hack-a-way. I also added a wiki page for the 
2.4 release to identify the 2.4 features that needed documentation. The 
thing is, it's all rather messy, and there is no clear place to point 
new DIG volunteers to say, this is what we need for documentation.

We already have some bugs in Launchpad with a documentation tag that 
haven't received a lot of attention. However, I think if this were our 
main method for tracking documentation needs and if we integrated it 
into the DIG web pages in the right way, they would get more attention.

If we were to use the documentation tag, we could create a link from the 
"How to Contribute" page that brings people to all of the LP bugs with 
that documentation tag.

We may also want to use other tags like circ, opac, admin, etc. to once 
again make it easier for people to find the areas where they are most 
qualified to contribute. Once again, we can create links from the "How 
to Contribute" page to make it really easy for potential contributors to 
find the documentation needs in their area of interest.

As we discussed in today's meeting, we might also want to make use of 
something similar to the bitesize tag that is used by developers to 
identify really small documentation needs that can be used by people 
just getting started with DIG. We probably should use a different term, 
though, so that the doc bitesize bugs aren't mingling with the code 
bitesize bugs.

If others are agreeable to using Launchpad, I think I'll add the 
remaining 2.4 doc needs there to get started.

Kathy

Kathy Lussier
Project Coordinator
Massachusetts Library Network Cooperative
(508) 343-0128
klussier at masslnc.org
Twitter: http://www.twitter.com/kmlussier

On 7/31/2013 10:25 AM, Yamil Suarez wrote:
> Hello,
>
> This is an action item that I had from the last DIG meeting. I wanted to bring up the idea that we should try to use Launchpad to report DIG related issues like bugs/errors in existing documentation, and to report missing documentation. Of course we currently have a sizable amount of missing documentation, but we are hoping to use Launchpad as a way to keep track of individual request for documentation. Perhaps so that we can use Launchpad during DIG meetings and hack-a-ways to chip away at what we are missing.
>
> One more thing, we might want to add a small comment on the page that is linked on the EG website for submitting bug, so that it mentions some quick guidelines for submitting documentation bugs. For example, a link to the online version of the error or what page number and filename for the PDF version, etc. At the last meeting we also discussed asking bug submitters to add the "documentation" tag to the new bug report, though that can be done by others later on.
>   
> http://evergreen-ils.org/dokuwiki/doku.php?id=dev:bug_wrangler:faq
>
> Comments?
>
>
> Thanks in advance,
> Yamil
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation