We have two goals for technical documentation in 0.6:
(1) Support a python programmer who wants to write a flickr-like parcel
(2) Document technical decisions made in 0.6 to leave a paper trail
We've drafted a documentation plan to meet these goals, captured here:
http://wiki.osafoundation.org/bin/view/Projects/ZeroPointSixDocumentation
Note that this plan lists a bunch of docs that are tutorials. The
audience for these documents is python developers who are not especially
familiar with Chandler -- our prospective parcel builders.
The plan also lists some tasks to update technical specs or do writeups
for significant 0.6 projects. These tasks are intended to support goal
(2). When writing these documents, you can think of the audience as
other developers at OSAF who are not working in your area -- these docs
can assume some familiarity with Chandler concepts and don't need to be
super polished. Ultimately, these docs may also prove useful to a
broader audience -- people who join the project later to add core code,
or people who write more polished docs down the road.
We've assigned bugs for most all of the tasks, except for epydoc.
(Epydoc is expected for all public apis).
I know that most of you are busy fixing bugs and finishing features and
improving performance, and not focused on documentation writing just
yet. The deadline for these documents is at the end of the release. The
intent here is to have the plan in place to make sure that we allocate
ourselves enough time to hit our goals.
BTW, other release related documentation (website, readme, user doc,
etc.) is being organized by Sheila, she'll send out more info about that
later.
Comments welcome.
Cheers,
Katie
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev
