Bazaar Developer Guide (Proposed)

[Robert Collins]

We just had a long discussion on IRC about this. Martin is sending
something about that shortly. I wanted to capture the key requirements
that we all agreed on during that discussion, as its fairly core to the
issue:

We need:
developer docs for plugin authors for each release;
developer docs for contributors to 'core' for the current release only;
sysadmin docs for folk managing a shared resource;
end user docs for users.

We want docs that:
 - cover bzr, bzrlib, and also docs for plugins - they should be in the
   same system and accessible in the same way
 - are referenced from bzr help at appropriate places
 - are in plain text format for console readers, 
 - and have an html for easy browsing,
 - and pdf or other 'print friendly' format.
 - match a specific version of bzr
 - have been reviewed by the same qa procedure as all our code goes
   through (but not necessarily using the same mechanism) (e.g. if the
   master is on the wiki, making patches is not as easy as saying 'rev X
   on the wiki'.)

I think it would be nice to have folk that are good at prose but not at
code be able to contribute to the docs, but I dont think that that is a
requirement.
I dont think it is a requirement because it is code authors that are
responsible for obsoleting old docs, or creating a need for new docs; so
the onus should be on them to include appropriate 
 documentation - if its not great prose, then we as a team can help.

--Rob
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20070412/57d027e2/attachment.pgp