organizing manuals on the wiki

Marko Knöbl openmoko.marko at
Wed Jul 22 14:58:37 CEST 2009


Because of the recent efforts of creating a manual for SHR I have
looked through the wiki and I have found that there are already
several pages that could be seen as manuals for some distributions.
However these are totally unstructured. Therefore I'd like to have
some kind of standardisation about where the manuals should be put.

For example Om 2008: I've found these pages which describe parts of Om 2008:
"Getting Started with your Neo ReeRunner", "Om 2008 guide", "Om 2008
Sudoku", "Om 2008 keyboard", "Om 2008 Installer" and "Om 2008
locations". These pages are only loosely connected and hard to find.

Therefore I would like to organize these manuals so information can be
found more easily and they can be maintained better.

My plan would be to separate device-specific information from
distribution-specific information. So I'd propose to have
device-manuals and distribution-manuals.

Device-manuals could be written for Neo FreeRunner, Neo 1973 and
probably E-TEN M 800 (SHR semms to work on this device). They would
contain information about buttons and connectors, opening devices,
inserting SIM/memory card, updating bootloader and GSM-firmware. The
first sections of the page "Getting Started with your Neo FreeRunner"
would be a good starting point for these pages.

Distribution manuals would be manuals about certain distributions and
basic applications of these distributions, no matter on what hardware
they are installed.

What do you think? Is this a good idea?

More information about the documentation mailing list