Re: WRONG!..... -ish?

Subject: Re: WRONG!..... -ish?
From: wanda <wetcoastwriter -at- me -dot- com>
To: Techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 03 Feb 2012 13:24:48 -0500

I can't believe that's it's Friday already. Whew.

So I can get my two pennies in before the week ends. Yes, sentence one is grammatically correct. Yes, context will indicate whether one would recommend or warn/caution and that would affect the structure of the statement. And, like Suzanne, I am accustomed to structuring the information differently. I'm accustomed to tagging the information as a note/caution/warning with formatting to call it out. I'm also used to providing the action and issue (removing the cover causes this particular problem), recommended action (don't do it), and recovery actions in case you didn't heed my hand waving. It may result in more text, but it provides the information the user needs to avoid a problem and recover from the problem if they are reading this information too late in the process.

Interestingly, I find this conversation ties back to the thread about the trends in tech writing where content can be migrating towards a quasi-robotic feel because of single-sourcing and minimalism. I can, and will, write an essay on this based on my experience with migrating content to DITA and increasing the single-sourcing capacity dramatically without destroying the quality of the writing and the users' experience. The writing actually improved during the transition; the variation in styles smoothed out and after the first complete round of documentation releases, the editing process also improved.

They can find this information in the index if they look. They can search for it. They can find it using the structure of the document.

And now, back to my business plan, my blog plans, and my weekend. I'm so happy to be back on this list.

wanda
wetcoastwriter -at- me -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
WRONG!..... -ish?: From: McLauchlan, Kevin
Re: WRONG!..... -ish?: From: kcbillb2
RE: WRONG!..... -ish?: From: Dan Goldstein
RE: WRONG!..... -ish?: From: Porrello, Leonard
RE: WRONG!..... -ish?: From: Dan Goldstein
RE: WRONG!..... -ish?: From: David Harrison
RE: WRONG!..... -ish?: From: Cardimon, Craig
RE: WRONG!..... -ish?: From: Porrello, Leonard
RE: WRONG!..... -ish?: From: Dan Goldstein
RE: WRONG!..... -ish?: From: Cardimon, Craig
Re: WRONG!..... -ish?: From: Peter Neilson

Previous by Author: Subject: Re: Bloated Docs: Identifying What's Useful
Next by Author: Re: Employment....
Previous by Thread: Re: WRONG!..... -ish?
Next by Thread: RE: WRONG!..... -ish?


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

Sponsored Ads


Sponsored Ads