🚀 go-pugleaf

RetroBBS NetNews Server

Inspired by RockSolid Light RIP Retro Guy

Article View: borland.public.delphi.documentation
Article #79

Re: D2007 Help scandal

#79
From: Simon Beesley
Date: Tue, 12 Feb 2008 14:46
29 lines
2430 bytes
One more thing.

I used to work as a technical writer, so I know what a demanding job it
is -- very hard to do good documentation, online or printed. But the
quality, clarity, comprehensiveness of the documentation is irrelevant if
the user can't access it. The bare minimum requirement for a help system
is that it should be available, and if available, organised in such a way
that the user can find what he is lookng for without too much trouble even
if he doesn't know exactly what he is looking for or what the terms to
search on are. The structure and organisation of the help is far more
important than the way it's written.

D2007's help is particularly bad in this respect. As well as being
impossibly slow -- even when restricted to 'Local only' -- it's very badly
organized. For example, if you type a VCL component name as the search term,
you will eventually get a help page for it as one of the first few results,
along with several hundred other results, most of which are arbitrarily
organized properties and methods of the component (and thus redundant since
they already available in the main help entry for the component). And a
fairly high proportion of "See Also" items don't have links to them.

To be fair, context-sensitive help (Ctrl F1) is usable. But it's in the
nature of context-sensitive help that it works only for specific components.
Searching for help on more general topics is usually an exercise in
frustration.

And so on ...

Simon
Technical Details
Message-ID: <47b1b159$1@newsgroups.borland.com>
Path: arc1-ca.pugleaf.net!g2news1.google.com!news2.google.com!news1.google.com!border1.nntp.dca.giganews.com!nntp.giganews.com!newsfeed00.sul.t-online.de!newsfeed01.sul.t-online.de!t-online.de!newsgroups.borland.com!not-for-mail
References: <47ad9bd1@newsgroups.borland.com>

Show Full Headers
Complete Article Headers
X-Google-Thread: 10a202,23d1e04f60a7e743
X-Google-Attributes: gid10a202,public,usenet
X-Google-Language: ENGLISH,ASCII-7-bit
From: "Simon Beesley" <simonbeesley@clara.co.uk>
Newsgroups: borland.public.delphi.documentation
References: <47ad9bd1@newsgroups.borland.com>
Subject: Re: D2007 Help scandal
Date: Tue, 12 Feb 2008 14:46:19 -0000
Lines: 32
X-Priority: 3
X-MSMail-Priority: Normal
X-Newsreader: Microsoft Outlook Express 6.00.2900.3138
X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3198
X-RFC2646: Format=Flowed; Original
NNTP-Posting-Host: 80.168.237.17
Message-ID: <47b1b159$1@newsgroups.borland.com>
X-Trace: newsgroups.borland.com 1202827609 80.168.237.17 (12 Feb 2008 06:46:49 -0700)
Path: arc1-ca.pugleaf.net!g2news1.google.com!news2.google.com!news1.google.com!border1.nntp.dca.giganews.com!nntp.giganews.com!newsfeed00.sul.t-online.de!newsfeed01.sul.t-online.de!t-online.de!newsgroups.borland.com!not-for-mail