[Date Prev][Date Next]
RE: Docs Organization
> From: email@example.com [mailto:firstname.lastname@example.org]On Behalf Of
> However, I also don't think that you will be able to get away from
> describing commands, fields, views, menus and buttons because
> eventually it
> will used for GEMS online help screens.
> So in my humble opinion, you may have to follow both methodologies.
Hmmm, good point. I would go one further and say that the fields, menus,
etc should (or at least could) strictly be used for online help.
I don't like tying field names etc to written docs for what it is worth. My
opinion is that if the purpose of a field is not "obvious" then either (1)
the interface sucks, (2) the process/purpose of the dialog was not explained
very well, and (3) (last) there should have been a help button. Also, the
software interface should be allowed to change for the better in the "sucks"
case without having to (completely) rewrite tons of docs.
Again I underline that if the electoral process (as we interpret it) is
explained, then how to use GEMS should be obvious. If it is not, then GEMS
probably needs work, not the docs.
- From: "robert" <email@example.com>