[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Tads3] Eric Eve's Getting Started guide



In a message dated 9/13/2003 6:43:52 PM Pacific Daylight Time, mjr_@hotmail.com writes:


Since several people have said they prefer documentation in HTML format, I'd
be interested in any examples of HTML documentation that's especially good
in terms of its design for electronic viewing.  I've cobbled together a
reasonable toolset that will single-source to HTML and PDF, so I'm not too
worried about the technical aspects of producing in both formats; nor am I
too worried about coming up with a reasonable design for print, as there are
plenty of examples of well-designed technical books to look at.  But my
personal experiences as a user of HTML documentation have left me
unimpressed, and I don't think I've come across an example that I'd want to
emulate.  I have some ideas of my own about it, but if anyone knows of an
existing piece of HTML documentation that they found especially usable, I'd
find it useful to study its design.

--Mike



I have not seen that many HTML FAQs that do much more than link a table of contents and, occasionally, subtopics. Sometimes that is enough. Other items could be cross-referenced, but usually they aren't. Unfortunately, a Windows Help File does this best (unfortunate because it's PC based). There are programs that help one do extensive cross-referencing -- that help one create a Windows Help File.

As for HTML, the best ones I have seen are the r*if FAQs and the various How-To Linux FAQs. Probably the Linux ones are the best. Some of those do more cross referencing than one normally sees.

Doe