Developer review of documentation

Jono Bacon jono at ubuntu.com
Tue Nov 28 12:51:52 UTC 2006


On Tue, 2006-11-28 at 11:13 +0000, Matthew East wrote:
> We'd need to make a list of the key documentation to be reviewed (this
> could include key system documentation, *and* key wiki pages), and
> potentially identify the relevant developers who might be able to lend a
> hand.
> 
> How does that sound as a vague plan?

There are a few ways of resolving this problem. Although your experience
getting developers to lend a hand was positive, that surprises me - I
would have thought the developers would be too busy for documentation.

To me it seems we need to enforce the concept of a moderated knowledge
base (which is what help.ubuntu.com seems to be). Wikis are great tools
for collaboration and for temporary events and issues, but more solid
information needs to live in the knowledge base. I would encourage the
doc team to flag up items on the wiki, check them for grammatical and
technical accuracy and merge them into the knowledge base.

I think the key thing here is that the production of content should be
done in a collaborative place - wikis, forums, mailing lists, IRC, but
the final product needs to live somewhere for end users. For us to get
the most out of this, we need to have a solid process in place that is
realistic to the resources in the docs team.

How about we schedule a meeting about this sometime?

	Jono

-- 
Jono Bacon
Ubuntu Community Manager
jono(at)ubuntu(dot)com
www.ubuntu.com / www.jonobacon.org





More information about the ubuntu-doc mailing list