TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Besides saying that it depends a lot on the industry you write for, I think
that's a good list. Our tech writing department also writes two forms of
bulletins which notify our banks of changes to the system. These bulletins go
out (ideally) 10 days before implementation, and serve as documentation until we
release updated policies and procedures for their Reference Manual.
The tech writers don't write the following documents, but they are a crucial
part of any project: Project Initiation Documents and Project Objective
Documents. These are written by analysts, and give a lot of background and
detail for the projects.Sometimes, although not always, these documents include
at least some design specs. We actually use these (along with standard torture
methods) to get the information we need to determine the documentation needs for
the project--updates to existing manuals, new manuals, other kinds of
documentation... In some companies the tech writers create these documents.
Jo
--
Jo Baer
Senior Technical Writer
TCF National Bank
Minneapolis, Minnesota
jbaer -at- mailbox1 -dot- tcfbank -dot- com
Weakness Through Strength
Fanatics may defend a point of view
so strongly as to prove it can't be true.
Piet Hein
Ellen Vanrenen wrote:
<snip>
> 2. Here is a list of documents. Does anyone know a site where I can find
> examples, definitions and/or templates of each? Can anyone add to the list?
> We do not write any of the programmers' design docs or the like:
>
> * user guides
> * reference guides
> * quick reference guides
> * application notes
> * technical reference manuals
> * technical specifications
> * white papers
> * installation guides
> * programmers' guides
> * release notes
> * policies and procedures
> * installation and operation guides for hardware
> * disaster and recovery
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
