[proposal] Split User Guide (was: The "It's Just a Desktop Distro" Problem)

Alexander Poslavsky alexander.poslavsky at gmail.com
Wed Jan 5 23:05:43 UTC 2005


On Thu, 6 Jan 2005 00:51:24 +0200, Sean Wheller <sean at inwords.co.za> wrote:
> On Thursday 06 January 2005 00:28, Robert Brimhall wrote:
> > I think splitting the docs into two categories is a great idea,
> > however, what about tasks that may fall under both groups (like
> > software updates, explanation of sudo, etc.)... should there be a
> > Ubuntu primer that preceeds the user and admin guides?
> 
> We will need to decide on which do they stay in - User Guide or Admin Guide.
> 
> In cases where we need content in both we can use XInclude and XPointer.
> For example: Let's say that the section "Software Updates" is kept in the User
> Guide. We can used XInclude or XPointer to include the content in the Admin
> Guide. This way we need only update the "Software Updates" section contained
> in User Guide and the Admin Guide is also updated.
> 
> I am trying to get lots of this type of methodology into the framework in
> order to reduce maintenance overhead and translation times. In the latest
> case, the menu choices, I have used External Entities as this was more
> effective. We already use XInclude so this should not be a problem.

This idea I like a lot. It will make it feel like the user-guide stays
in place, thus making less changes. And at the same time it will make
a flexible framework for further work.

The user-guide should really stay as it is, at least in feel. If at
the same time we can, with docbook magic, make it change like magic
spagetti, that's ok with me.

gr, AP




More information about the ubuntu-doc mailing list