Re: "How to Write a User Manual"

Subject: Re: "How to Write a User Manual"
From: Lauren <lauren -at- writeco -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 11 May 2018 19:25:35 -0700

I read that passage; I think some of my brain cells just died. ClickHelp just got some negative advertising. Everything written on that page is bad from the stick in the hornet's nest approach to technical writers and technical writing, to a potpourri of errors (yes, we have abandoned the double-space after a period but there should still be one), to skin-crawling sentences, like, "For whom you are creating a user manual is the key moment, so let's take a closer look."

On 5/8/2018 11:45 AM, Robert Lauriston wrote:

It purports to be an introduction to writing a user guide, but it's
actually marketing copy for ClickHelp.

They don't know what they're talking about, hence the nonsense about
the documentation plan.

Their own documentation seems pretty bad, e.g. this topic on CSH:

https://clickhelp.co/software-documentation-tool/user-manual/context-help.html

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.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


References:
"How to Write a User Manual": From: Cardimon, Craig
RE: "How to Write a User Manual": From: Wright, Lynne

Previous by Author: Re: Space bar -or- Spacebar
Next by Author: Copyright/Trademark Usage
Previous by Thread: Re: "How to Write a User Manual"
Next by Thread: What do you write?


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

Sponsored Ads


Sponsored Ads