Mentoring Program

Matthew East mdke at ubuntu.com
Mon Aug 18 22:32:06 UTC 2008


On Sun, Aug 17, 2008 at 12:19 AM, Connor Imes <rocket2dmn at aol.com> wrote:
> Matthew East wrote:
>>
>> Yes, that's the one thing everyone on this thread agrees on :) Our
>> wiki pages went through a big evolution a year or so ago when we
>> rationalised the structure, but now seems like a good time to take
>> them up another level and try to make them simpler, better structured,
>> and clearer.
>>
> I think it would be better to keep most of the information centralized
> on one page, but very well structured, each part short, and to the
> point.  From there you can branch out to help pages for each area of
> documentation - even these need to be more centralized.

Here is my idea for the structure of the pages under
DocumentationTeam. The home page would be a simple explanation of the
different areas of our work.

/SystemDocumentation
  - /Introduction - brief explanation to processes and other pages in
this section.
  - /Repository - explains how to get our bzr branches and work with
bzr, also what documents exist and where to find them
  - /Editing - explains the basics of docbook and how to edit files
  - /Checking - explains how to view the edited files and use the
validation script
  - /Submitting - explains how to create a patch and file a bug or
write to the mailing list
  - /Tasks - list of system documentation only tasks

The material from the TechnicalReview process would go in here
somewhere (probably with "Editing") but I think it's currently a bit
too complicated, I'd like to eliminate the "status" page (we can use
the status tags in the xml for that if required) and simplify the
process a bit.

/WikiTeam - a series of pages moved from
https://help.ubuntu.com/community/WikiTeam and restructured (I haven't
yet figured out quite how yet). It would include:
  - /Tasks - from https://help.ubuntu.com/community/WikiToDo
  - /WikiCleanup - from https://wiki.ubuntu.com/DocumentationTeam/WikiCleanup
  - /ForumImports - from https://help.ubuntu.com/community/forum

/Mentoring

/Translation

/StyleGuide

/Contact

Thoughts/comments?

-- 
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF




More information about the ubuntu-doc mailing list