[Freeciv-Dev] Re: Wiki page for Freeciv manual

[Vasco Alexandre Da Silva Costa <vasc@xxxxxxxxxxxxxx>]

On Sun, 11 May 2003, T.J.T van Kooten wrote:

> Proper documentation is indeed a must. Going by the results of the
> poll CMA is a good example. Most people seem to be unaware of this
> feature because (a)the important info is buried away in a readme, (b)
> isn't mentioned in the official manual (this is were a wiki system could
> help) and (c) isn't properly explained in the game itself either (we need
> more help popups).

There is help. Just go to the "Help" -> "Citizen Management" menu entry.

IMHO the problems are:

1)
CMA is not exactly obvious to anyone. We should not use acronyms willy
nilly. It is better to choose a short name and stick with it.

e.g. Mayor, Auto-Manager.

I am sure there are more and better choices. Feel free to suggest some.

2)
We should add a help button to the CMA city pane which goes directly to
the help entry in the browser.

3)
The mention to README.CMA should be removed from the GUI. It is mentioned
in the help entry. That is enough.

4) "But beware!" is not inspiring. "NOTE:" is more innocuous.

5) Some rethinking of the UI may be in order. The Presets list for example
seems to be disproportionately huge and kind of unfocuses the user. The
other elements may benefit from some touchups.

---
Vasco Alexandre da Silva Costa @ Instituto Superior Tecnico, Lisboa