Re: Ideas for Help 2.0

Subject: Re: Ideas for Help 2.0
From: Julie Stickler <jstickler -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 12 Jan 2012 17:23:19 -0500

Just another thought to throw into the conversation. If you do
anything too "cutting edge" or complicated, what's the maintenance
cost? How stable is it? (Will having the wrong version/release of a
component break the system?) What browsers will you support and which
versions?

And bear in mind while you're designing it, that you may not always be
around to take care of it. What happens when you leave the company
and they hire someone else to maintain the flashy help that you've
built? I've worked with a number of remarkably UNtechnical technical
writers in my career. And I've worked on projects where it took me a
very long time to figure out what on earth the previous writer had
done to their files?

Whenever I do anything even slightly complex in a project, I always
leave a doc that explains what I did. And why. (Sometimes it's just
so that six months later when someone asks why I didn't do X, I can
say, "I tried that and it blew up in my face.") So while you're
building your kick ass help, remember to leave some breadcrumbs for
the next writer to work on it.

--
Julie Stickler
http://heratech.wordpress.com/
Blogging about Agile and technical writing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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://www.doctohelp.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
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -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:
Ideas for Help 2.0: From: Roger Goodman
Re: Ideas for Help 2.0: From: Tony Chung
Re: Ideas for Help 2.0: From: Jen Jobart

Previous by Author: Re: Interface editing
Next by Author: Software for large graphics?
Previous by Thread: Re: Ideas for Help 2.0
Next by Thread: blogs & newsletters for doc trends ? (Ideas for Help 2.0)


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

Sponsored Ads


Sponsored Ads