[Dev] 0.7 developer documentation [Was: Proposal for 0.7 "mini-release" non-code deliverables]

Katie Capps Parlante capps at osafoundation.org
Tue Feb 21 15:33:59 PST 2006


>> + We would not expect any supporting developer documentation.
> 
> In some cases we will need to have some developer documentation -- we 
> are looking at big reworkings of collections and CPIA, which will impact 
> the example parcels and any parcels being developed outside of OSAF.   
> If we don't document those changes, then we will at least need to put up 
> a warning telling parcel developers that their parcels will not work 
> after a particular alpha version.

Instead of doing all developer documentation in a big bang at the end, 
we may want to schedule some deliverables to appear at various alpha 
milestones. For example, it might make sense for documentation of a 
particular api to be in the same milestone that the api work is done.

That said, I agree with the spirit of the proposal, which I take to be 
"It is ok for the developer documentation to be phased or semi-complete 
at each alpha milestone".

The developer documentation for 0.7 should be phased along with the 
alpha milestones -- I'll work on a proposal. Reply to the dev list if 
there is dev documentation you'd particularly like to see in 0.7, or 
wait for the proposal and comment then. :)

Cheers,
Katie


More information about the Dev mailing list