Re: how long does "fixing" a document take

Subject: Re: how long does "fixing" a document take
From: <neilson -at- windstream -dot- net>
To: "Carrie Baker" <carriebak -at- gmail -dot- com>, TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 11 Jun 2007 8:26:46 -0400

Two pages a day, exactly.

Unless of course there are any difficulties, such as:
- Steps left out
- Combinations of actions that lead to stubs that were never
implemented, or into coding errors that lead to crashes that
you cannot document and for which you must invent workarounds.
- Unreasonable defaults that always need to be respecified.
- Ambiguously incomprehensible original material that resolves
into three additional pages.
- Unavailability of the SME to help resolve the ambiguity.
- Other ordinary tech-writer stuff that isn't just pounding the
keyboard.

And there are always difficulties.

Carrie Baker asks:

> I am sure that this is a question where the answer is "it depends",
> but I would like to get a sort of estimate to see if I am in the
> correct direction.
> A programmer for whom English is not their mother tongue, wrote an
> internal document explaining to sales staff how to demonstrate a
> complex application. (it is not a user guide, but more in the
> application note direction).
> The document is around 31 pages long and covers over 20 screens some
> of which are divided into additional panes etc.
> I was asked to edit this.
> Apart from editing, I am running the data he used, with the
> application to make sure no steps are missed out.
>
> All in all, I am fixing the English, adding formatting, (headings,
> numbers whatever is required), and making sure the whole thing makes
> sense and works.
>
> This seems to be taking me a long time. How long do you think
> something like this should take??


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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.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-unsubscribe -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.techwr-l.com/ for more resources and info.


Follow-Ups:

Previous by Author: Re: Standards for units and values
Next by Author: Automatic editing?
Previous by Thread: RE: how long does "fixing" a document take
Next by Thread: Re: how long does "fixing" a document take


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


Sponsored Ads