[josm-dev] Please invest some time into documentation - especially confilict resolution

Ævar Arnfjörð Bjarmason avarab at gmail.com
Sun Oct 4 10:56:14 BST 2009


On Sun, Oct 4, 2009 at 9:18 AM, Dirk Stöcker <openstreetmap at dstoecker.de> wrote:
> On Sun, 4 Oct 2009, Rolf Bode-Meyer wrote:
>
>> There was a post just yesterday where some people agree that they just
>> push the buttons at random until the conflict is either resolved or the
>> changes completely messed up.
>
> Users always request better documentation, but when there is a good
> documentation it is not read usually.
>
>> So please would those people who implemented conflict handling give
>> detailed explanations in [[Help/Dialog/Conflict]] which currently is
>> simply not helpful?
>
> You really need no programmer to write documentation.
>
> A good way to reach that goal would be to start writing that documentation
> and ask the developers to fix or continue wrong or missing parts only.
> Most of the docs can be written without knowing how the things work in
> detail:
>  - describing appearance and situations
>  - making screenshots
>  - showing different situations and ways to handle them
> Asking specific questions here like "what does that button do" can help to
> solve troubles and the explanations can be copied into a doc.
>
> Till now I was not able to convince one single person to really update
> JOSM online docs (with more than typos), so it seems doing that work is
> not worth the effort.

Perhaps it would help if there was a way in JOSM to link from each
dialog / logical part of the UI to the associated documentation page.
Then you could always click "Help (for this dialog)" to get at the
documentation.

It's not easy just to *find* the docs so more exposure might help things.




More information about the josm-dev mailing list