I've been doing some work on the wiki to improve our basic documentation 
structure.

Some goals:
* keep individual pages focussed and as small as reasonably possible
* find and link related areas easily
* avoid duplication
* keep it maintainable
* provide authoritative information for Mer - bad information is a major bug

Initially I'd been working on a big 'About' page with lots of subsections or
sub-pages. Each area would focus on a topic and provide a summary with links to
relevant pages and external resources.

This began to get messy so I did some research and decided to use the wiki
category mechanism instead.

We now have a page: http://wiki.merproject.org/wiki/Category:About which should
provide a 'concept index' for Mer.

I have explained how this is implemented and put some suggested guidelines in
this page: http://wiki.merproject.org/wiki/About_category_guidelines - please
discuss.

This way each concept has it's own 'authoritative' area - if you want to know
about mic2 in Mer you go to http://wiki.merproject.org/wiki/Category:About and
click on mic2

More importantly, when discussing mic2 in another context there should be no
need to provide installation information, links to repos or guidance - that can
be done easily by providing a single link to the mic2 category page. This avoids
duplication (which gets outdated) and keeps the flow of the narrative clean.

Keeping with mic2 as an example : a word about marking a page as a
'Category:mic2' ... this should only be done if the page content is
significantly about mic2 - not just when it mentions it in passing (or even a 
lot).

OK, enough typing, please discusson here or on irc and feel free to edit
(thoughtfully)

David

-- 
"Don't worry, you'll be fine; I saw it work in a cartoon once..."


Reply via email to