Documentation Review

Subject: Documentation Review
From: Annie Wood <yossari53 -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 2 Jan 2007 05:53:21 -0800 (PST)

Hi All -

We are currently reviewing our documentation processes and are looking to get some feedback about how other teams/companies handle reviewing their documentation.

Do you have a process for reviewing/testing/proofreading documentation?

What do you review in the documentation? Content, grammar, layout, style (both wording and/or applying templates), or functionality of the Help (other documentation)?

Who reviews the documentation? Another technical writer, editor, proofreader, SME?

Do you use any sort of defecting tracking software?

Do you provide the reviewer with anything explaining the changes in the documentation?

Any information is much appreciated!

Thanks,
Annie

__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: RE: What is SOX compliance?
Next by Author: Re: Documentation Review
Previous by Thread: Re: Dia as replacement for Visio
Next by Thread: Documentation Review?


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


Sponsored Ads
http://www.techwr-l.com/archives/0701/techwhirl-0701-00004.html
www.techwr-l.com
crawl=CC-MAIN-2022-05
24194
application/http; msgtype=response
sha1:FFUIGHN26S5VWA6QEBJB46WSDK4FHG4P
<urn:uuid:af1961f3-b9b3-4a4d-9532-5342a0749168>
2022-01-23T05:29:53Z
184.106.92.169
text/html
sha1:PLTBVENV7TRMEZHSUTPE3BKD3B5SUEDO
<urn:uuid:f8ea00df-0581-49c9-be04-0e185c6e4595>
http://www.techwr-l.com/archives/0701/techwhirl-0701-00004.html
response
<urn:uuid:7d8653fd-1693-4321-82a6-030bdd422ee6>
isPartOf: CC-MAIN-2022-05
publisher: Common Crawl
description: Wide crawl of the web for January 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-184
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.3-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/