On Friday 02 November 2001 17:35, John Levon wrote:

> I would hope that the Qt2 dialogs are intuitive enough to not need
> documentation. Remeber the dialogs have the same responsibilities, so if
> there is e.g. a boolean flag, it will be in both dialogs.

John,

Not to start a debate (after all, we have a clear directive for the moment: 
document to the xforms interface), however for future consideration as we 
will have to wrangle with this issue somewhere down the road....

One of the problems with this is that we aren't documenting to the coding of 
the dialogs. We are documenting to the visual aspects, and the individual 
functionalities of the dialogs (and for that matter, the menus).  So, when 
the layout and arrangement of them changes, even if they are minimal and/or 
intuitive, the documentation must reflect it.  Yes, this amounts to 
hand-holding, IMO.  However, this also one of the reasons why there is a huge 
market for aftermarket books: to hand hold the user through the user 
interface of a program.

So, (I think) we're looking at this from a documenting functionality and "how 
to" standpoint.  By using that as the criteria, it's going to be necessary to 
document to the interface.  Once we reach multiple, mature interfaces, that 
becomes a possible issue.

Personally, I see the whole thing as just another big challenge...  But, as 
Mike can see, it will be a major undertaking and could be very fertile ground 
for large issues to rear their ugly heads. :) (To which, I can only 
concur...:)

// George

Reply via email to