{Desktop 12.10 Topic] Holistic approach to Ubuntu documentation

Bryce Harrington bryce at canonical.com
Thu Apr 19 03:51:33 UTC 2012


On Thu, Apr 19, 2012 at 03:51:02AM +0200, Jo-Erlend Schinstad wrote:
> Den 19. april 2012 03:11, skrev Jeremy Bicha:
> > Your topic mixes developer docs, entry-level user docs, and "power
> > user" docs. Each of those needs a different approach and I think it's
> > simpler to tackle them as three mostly separate things. Also, if
> > you're going to discuss documentation, you should probably include the
> > docs team (CC'd now) as that's where people interested in that read. 
> 
> The point is the exact opposite. We shouldn't split documentation up
> into completely unrelated pieces. That is the problem. We should
> consider it a whole. One single tree of knowledge. Before a release, we
> should be able to walk the entire tree and make sure all documents are
> Obviously Valid. You don't have to specialize in a single topic in order
> to do that. It just requires effort, and for that, it must be obvious
> what to do.
> 
> With different docs being at different places, organized in different
> ways, maintained by "unrelated" teams and mixing versions, it's very
> difficult to do any kind of quality assurance or to do anything in a
> systematic way – as a whole.

Well, both of you make valid points.

Can the documentation be *maintained* in a single tree, yet split out by
user type (one set for my mom, one for me)?

Bryce



More information about the ubuntu-doc mailing list