Changes between Version 3 and Version 4 of Event/2011/GoogleDocSprint


Ignore:
Timestamp:
09/14/11 23:51:10 (10 years ago)
Author:
Michael Howden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Event/2011/GoogleDocSprint

    v3 v4  
    1 = Google Doc Camp =
     1= Google Doc Sprint =
    22
    3 Google is hosting a [https://sites.google.com/site/docsprintsummit/ doc camp], prior to the 2011 GSoC Summit, to produce or improve documentation for selected GSoC organizations. A proposal for Sahana was accepted, and Michael, Shikhar, Leslie, Dominic, and Fran will be attending.
     3Google is hosting a [https://sites.google.com/site/docsprintsummit/ doc camp], 17th - 21st October, prior to the 2011 GSoC Summit, to produce or improve documentation for selected GSoC organizations. A proposal for Sahana was accepted, Michael, Shikhar, Leslie, Dominic, and Fran will be attending.
     4
     5== Desired Outputs ==
    46
    57=== Quick Start Guide ===
    68Part of the event will be the production of a "quick start guide". Please add suggestions here for organization and contents.
    79
    8 === Online docs ===
     10=== Wiki Docs for Developers ===
     11Generally:
     12* How things work
     13* How things are linked together
     14* Integrate back-end framework with front end interface
     15
    916There may also be work on the online docs, i.e. this wiki. Please record here any gaps you've encountered in the online docs, or any parts that are out of date, or anything unclear. Of course, you can also fix those things. ;-)
    10 
    1117 * Developer installation instructions for Mac needed -- Macs are increasingly popular among devs.
    1218 * Order of production installation instructions seems inverted -- one must navigate into pages for specific types of web server setup to find parts that cover installation of the actual software, e.g. Web2py, Python and dependencies, Eden.
    1319 * Production installation links for Windows Server don't include installation of the actual software.
     20
     21=== Wiki Docs for User ===
     22* Screen casts are good
     23* Provide guidance for GCI students to produce more documentation - including simulations
     24* Useful for:
     25 * For developers (context)
     26 * For testers
     27 * For users (although these will often need to be adapted for specific business processes/context)
     28
     29=== Steam-lining Documentation ===
     30 Is there a way to automatically generate guides & presentation for use in trainings and printing from our wiki content
     31
     32=== FOSS for a Better World Guide ===
     33* (Humanitarian / Development / Health / Environment)
     34* This could be a project agnostic guide, probably more aimed at the users of FOSS, rather than the developers.
     35* Basically it would contain all the information which I wish non-techies understood when I was working with them:
     36 * Information Management basics
     37 * Technology Options (Maps, Mobile, SMS)
     38 * How to specify System/User Requirements
     39 * IT Project Cycle
     40 * Usability
     41 * Training
     42 * Integrating different systems (XML).
     43* Just a small book 30-60 pages, easy to digest, pretty diagrams & colors…
     44* Something I've come across before is: http://www.ecbproject.org/GoodEnoughGuide - different topic, but same audience and type of document.