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

[Pieter Hartsook]

On 2/21/06, Katie Capps Parlante <capps at osafoundation.org> wrote:
>
> >> + 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".


In particular, if we anticipate the release of some significant
documentation that may not be ready at the time of the code release, I think
we ought to create a place holder with information about the scope of the
document and target date for delivery. It conveys to our audience that we do
know what's important, and that we are in fact working on it. Then we can
update the site when the documentation is ready even if it doesn't coincide
with a code release.

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
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "Dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.osafoundation.org/pipermail/design/attachments/20060222/0831d3dc/attachment.htm