Changes between Version 14 and Version 15 of Community/Tasks/SourceDocs

Show
Ignore:
Timestamp:
07/20/07 11:04:12 (7 years ago)
Author:
martin (IP: 81.178.2.19)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Community/Tasks/SourceDocs

    v14 v15  
    44On this page the community is welcome to list tasks that will improve the usability of the !OpenSceneGraph library by improving the documentation of its source code, in particular its classes/methods/fns/enums.  
    55 
    6 Note that the aim of this initiative should '''not''' be to reproduce the OSG book that is in-the-making. Rather, it should focus on the interface aspects of the OSG source code. It should also not be concerned with spelling or grammar, as this is covered by other tasks ([wiki:Commnunity/Tasks/Spellingbee SpellingBee]), increases the level of effort needed (and therefore decreases the number of potential contributors), and does not provide usability value (except where the spelling or grammar mistake changes the meaning of the information, which is rare). Note also that this documentation effort should make it as easy as possible for any OSG user to contribute.  
     6Note that the aim of this initiative should '''not''' be to reproduce the OSG book that is in-the-making. Rather, it should focus on the interface aspects of the OSG source code. It should also not be concerned with spelling or grammar, as this is covered by other tasks ([wiki:Community/Tasks/SpellingBee SpellingBee]), increases the level of effort needed (and therefore decreases the number of potential contributors), and does not provide usability value (except where the spelling or grammar mistake changes the meaning of the information, which is rare). Note also that this documentation effort should make it as easy as possible for any OSG user to contribute.  
    77 
    88I propose several ''passes'' through the source code, each focussing on a specific aspect of documentation. Each pass should be a clear and simple task that is limited in scope, time, and well-defined, and possibly tied to release dates.