RE: "Internet Standard (STD)" - phrase known by Web programmers ?

Subject: RE: "Internet Standard (STD)" - phrase known by Web programmers ?
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: Monique Semp <monique -dot- semp -at- earthlink -dot- net>, TechWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 24 May 2012 12:40:04 -0400



> -----Original Message-----
> From: techwr-l-bounces+kevin -dot- mclauchlan=safenet-inc -dot- com -at- lists -dot- techwr-
> l.com [mailto:techwr-l-bounces+kevin.mclauchlan=safenet-
> inc -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Monique Semp
> Sent: May-23-12 3:14 PM
> To: TechWR-L
> Subject: Re: "Internet Standard (STD)" - phrase known by Web
> programmers ?
>
> > I would say something like "if your XSD conforms to the XML Schema
> Specification you should not experience
> Parsing failures as a result of an update."
>
> Ah, but the issue is that it's not whether the XML doc conforms to the
> schema. The point I need to make in the doc is that the reader must
> actually
> USE the XSD instead of just trying to use the XML file directly (both
> the
> XSD and XML files are provided to them). And when the user neglects to
> use
> the XSD, and it and the XML file change, then the user's processing of
> the
> XML of course fails.
>
> So it's not a matter of whether there's conformance; it's a matter of
> educating these unknowledgeable Web programmers in the doc audience how
> to
> do things right.
>
> But on to the bigger issue...
>
> <rant>
> I was told again to use "internet standards", not even capitalized, and
> definitely to not include any additional guidance or info, because, and
> I
> quote the developer *and* his manager, "Clarity is not needed in this
> regard."
>
> Why would it be ok to write something that we know is not clear?
>
> I am pushing back on this, but I fear that I may fail :-(
> </rant>
>
> Thanks for listening,
> -Monique

Something political is going on here. Nobody sane dictates
an explicit REQUIREMENT for lack of clarity, unless they
have an ulterior motive.

I do hope that you have been preserving all the IN-WRITING
exchanges on this matter. If it's not useful in an
employed-anymore-or-not situation, it might still come
in handy at annual review time, when your "plays well
with others" is called into question.

If they haven't been in writing, then now is definitely
the time to CYAWAM - lay out what you believe they are
asking/dictating, and "I just want to be sure that I have
not somehow misunderstood, and that you are intentionally
overriding my concerns, in the area of my own expertise,
that:

a) you wish me to use your term "internet standards" in
place of a short, simple explanation that would ensure
the maximum number of readers has a successful outcome
with our product

b) your term "internet standards" has no formal definition

c) you wish to limit the successful audience to just that
subset of all [web developers?] who have exactly and precisely
your formal education and your experience, culminating in
a precisely congruent understanding of your term "internet standards"

d) whatever else you can think of to insert here........ "



The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
Re: "Internet Standard (STD)" - phrase known by Web programmers ?: From: Laura Lemay
Re: "Internet Standard (STD)" - phrase known by Web programmers ?: From: Monique Semp

Previous by Author: RE: The Future of Tech Writing In America
Next by Author: RE: reasons, political or otherwise, for omitting info (was @internet standards and clarity)
Previous by Thread: Re: "Internet Standard (STD)" - phrase known by Web programmers ?
Next by Thread: reasons, political or otherwise, for omitting info (was @internet standards and clarity)


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

Sponsored Ads


Sponsored Ads