1 / 12

Building a Collaborative Documentation Model for the Access Grid (AG)

This presentation discusses "Corralling the Kitty Herd," a distributed model for creating and maintaining documentation for the Access Grid (AG). As user demands outpace available documentation, the current scattering of resources leads to inefficiencies and duplications. The proposed Access Grid Documentation Project (AGDP) seeks to establish a central, trustworthy source for documentation, where individuals can contribute efficiently without fostering an authoritarian approach. Key tasks involve format selection, author guidelines, and community engagement, aiming for a collaborative launch by April 1.

acton
Télécharger la présentation

Building a Collaborative Documentation Model for the Access Grid (AG)

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Corralling the Kitty Herd: A Distributed Model for AG Documentation Production Jennifer Teig von Hoffman Boston University Access Grid Technical Retreat, January 30-31, 2001

  2. Objectives • The background • The problem • The solution(?) • Start-up tasks (and other tasks) • Call for volunteers • Proposed timeline/next steps

  3. The Background • Need for documentation has out-paced creation of readily-available, “generic” documentation • Enterprising (and sometimes under-pressure) individuals have developed a variety of documents, frequently specific to a particular organization or event • Alliance AG Deployment group working on manual

  4. The Problem • New users (and old users attempting new things) have to hunt around for documentation • Danger of duplication of effort • Danger of important documents not getting written • Example: Is there a standard, AG-oriented intro to VNC? VTC? • Currently hard and/or inefficient to share documentation with each other

  5. So, What to Do About It? • What we don’t want to do • Create an authoritarian or autocratic body • Create the “one true way” to use and/or document the AG • What we do want to do • Provide a central source of trustworthy, well-organized documentation (canonical, even) • Make it (relatively) easy for authors to contribute to this effort

  6. The Solution(?) • Access Grid Documentation Project (AGDP) • Distributed documentation model based on www.linuxdoc.org • Herd metaphor not perfect: we don’t want a “herd mentality” here – independent thought is still both good and necessary

  7. AGDP Start-up Tasks • Determine what format(s) are required for new submissions, updates • Determine format(s) for document publication • Develop appropriate style guide, templates, and other guidance for authors • Develop manifesto • Develop document wish list • ie, list of stuff we wish somebody would submit • Set up web site and mailing lists • Set up revision control system

  8. A Few Related Tasks. . . • Figure out how to best use expertise already stored in ag-tech archives • Beef up the FAQ-o-Matic • Figure out where/how these might best fit into AGDP model

  9. Call for Volunteers • Team of reviewers • Day-to-day operations management • Management of review process (ie, routing to appropriate reviewer(s), follow-up nudges to reviewers) • Posting (and/or formatting, converting, etc) documents and revised documents • General web site and mailing list maintenance • Team to address format, style, authors’ guide issues

  10. Proposed Timeline • By February 15 • Firm up this proposed timeline/workplan • All feedback due from community on manifesto • Assemble team of reviewers • Assemble team to work on format, style, authors’ guide issues • Find a Wonderful Person™ to provide day-to-day management, or determine a way to share/rotate responsibilities

  11. Proposed Timeline (Cont.) • By March 1 • Manifesto finalized • Document wish list developed • Set up mailing lists • Document format(s) selected • First draft authors’ guide available for review by AG community

  12. Proposed Timeline (Cont.) • By March 15 • All feedback received from community on authors’ guide • Set up web site • Set up revision control system • By April 1 • Authors’ guide finalized • Launch the AGDP

More Related