[csw-maintainers] OpenCSW manual

Dagobert Michelsen dam at opencsw.org
Fri Jan 20 21:24:50 CET 2012


Am 20.01.2012 um 21:14 schrieb Maciej (Matchek) Bliziński:
>>> There is also a version (a stub) compiled to HTML:
>>> http://buildfarm.opencsw.org/~maciej/opencsw-manual/
>> This looks great.
>> Why not document on a(ny) wiki which is made for ease of
>> documentation? Where I work every document system failed until we
>> implemented wikis, now people from all areas document new stuff and
>> keep it updated just because it's so easy to do so.


> While wikis are good for vast knowledge bases, they don't allow for
> reading top-to-bottom. The idea behind the manual is that it's an
> introductory material for newcomers, which you read once,
> top-to-bottom, and it gives a basic understanding of what you're
> dealing with. The manual must not be large, each of the 3 sections has
> to be possible to absorb in one evening.  If we have a newcomer, we
> point them at the manual, and this should be enough to get anyone
> started with the project (from each of the three perspectives).

First lets please not discuss too long about the format. It needs
to be written. Convert it takes a fraction of the amount of writing it
if necessary.

Having a nice browsable thing and PDF is IMHO perfect for starters.

Best regards

  -- Dago

"You don't become great by trying to be great, you become great by wanting to do something,
and then doing it so hard that you become great in the process." - xkcd #896

More information about the maintainers mailing list