× The internal search function is temporarily non-functional. The current search engine is no longer viable and we are researching alternatives.
As a stop gap measure, we are using Google's custom search engine service.
If you know of an easy to use, open source, search engine ... please contact support@midrange.com.



> From: Larry Bolhuis
>
> Same as above. I'm in RPG source members. I want help about RPG.

Well, I doubt you'll ever see the Help topic trimmed down to some
context sensitive amount of data; that's what search keywords are for.
At the same time, I see your point about the manual not being very
specific.  For fun I just pulled my favorite reference book (JavaScript:
The Definitive Guide) from the shelf and thumbed to one of the syntax
reference pages in the back.  The title of the page didn't say anything
about JavaScript; it assumed you knew you were in JavaScript.

And that may be the problem.  Most books today are still written in a
fairly hierarchical top-down manner, with the assumption that you
already know where you are in the manual and that each page simply needs
to provide more detail about the topic you are currently on.  When texts
like that get translated to hypertext and then indexed by a search
engine, there needs to be something to tell the user the context of the
page.  Maybe just an icon on the upper right corner, that can be clicked
on or hovered over that will show the hierarchy of topics (chapter,
section, subsection).

Anyway, I'm going to think about this as I develop my new documentation.
Thanks for bringing up the point, Larry.

Joe


As an Amazon Associate we earn from qualifying purchases.

This thread ...

Replies:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2024 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].

Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.