We need better Gecko Developer Documentation.  Past efforts have failed 
to create lasting documents and that is partly a failure of process.  To 
break the cycle, we need concrete, implementable ideas on how to get 
there, and we need to *do* them.  We have been brewing a plan and would 
really like comments, suggestions and alternatives.

Here is the document.  You can comment using the Add Comment link at the 
bottom, or discuss here.

http://moz.zope.org/Members/jkeiser/gecko_doc/roadmap


To keep the scope "manageable," I only want to focus on Gecko internals, 
which is still a hell of a lot of stuff.  This does not mean standards 
support documentation, though it extends to *how* we support the DOM. 
This does not extend to chrome and only extends to XUL in that we will 
document where we use it in the rendering engine.  You can see the 
document map at http://moz.zope.org/Members/jkeiser/gecko_doc/document_map.

This is related to the overall effort Alex is working on in that 
developer docs are one facet of our documentation.  We are working 
together to make sure that wherever possible, we use the same 
technologies for developer docs and other types of docs.

It is my hope that by next week we will have this hashed out and have 
the Technote and Documentation Link types put into Zope, at which point 
we can put out the call for help to take stock of what is useful in our 
current documentation, as well as ask developers to start creating 
technotes, assuming people are on board with the plan :)

--John Keiser


Reply via email to