HTML docs

Subject: HTML docs
From: Arlen -dot- P -dot- Walker -at- jci -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 20 Jun 2001 16:55:28 -0500


And I just thought I'd toss out another thought on the general subject of
HTML docs, while it was fresh in my mind.

The new Smart Tag technology that MS is demonstrating in IE6 will insert
links into any document it views, based on values supplied to it by the
user (and by MS, of course). Some ramifications:

1) The page layout gets cluttered up with excess links that we didn't
design for, and in fact can't design for. Not a biggie, except when a user
calls up and wonders why your documentation has links to your company's
stock price, or Microsoft's, or perhaps even to your competitor's products.
Or worse, gets completely confused because he follows a link to
incorrect/contradictory information about your product and is holding your
company responsible for it.

2) Your boss may now look over your document and ask what all these
squiggly lines are. After you convince him they aren't spelling errors or
mistakes in grammar, he'll say "Get rid of them." And you'll have to figure
out a nice but effective way of telling him that you can't. (MS claims
they'll change the code so that the user can't set the preference for them
always to be on, but they haven't done so yet. And if you want to try,
you'll have to add a tag to every single page in your doc. Happy tagging!)

Both of these scenarios are likely to occur, so we'd best get started now
on building our explanations for them.

Have fun,
Arlen
Chief Managing Director In Charge, Department of Redundancy Department
DNRC 224

Arlen -dot- P -dot- Walker -at- JCI -dot- Com
----------------------------------------------
In God we trust; all others must provide data.
----------------------------------------------
Opinions expressed are mine and mine alone.
If JCI had an opinion on this, they'd hire someone else to deliver it.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com

Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: Re: Line breaks - HTML doc with printer-friendly PDF?
Next by Author: RE: HTML docs
Previous by Thread: Re: Damnit Jim, I'm a Writer, not a Programmer
Next by Thread: Re: HTML docs


What this post helpful? Share it with friends and colleagues:


Sponsored Ads