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.
Subject:One doc for each user ? From:Frederic Wronecki <frederic -dot- wronecki -at- WANADOO -dot- FR> Date:Wed, 24 Jul 1996 14:23:57 -0700
Ideally, a technical document should address one, and only one,
category of users.
But there are cases when a significant proportion of the
information must be simultaneously provided to all the categories.
It seems then difficult to compel writers (*) to design
different documents if the common core represents the biggest
part of each one.
I'm trying to set up a guideline for this.
I proposed the following rule :
Make one common document if, and only if :
- the common core represents at least three quarters (circa)
of the document ;
- AND you can display without any ambiguity (via typographical
attributes) which blocks of information address
which categories of users.
Some colleagues rated this "irrealistic", impossible
to implement and to check.
Any experience would be appreciated.
(*) to understand our background : we have no specialized
tech writers, technical documents are written by SME
(don't tell me this is not ideal, I know...)
who are naturally prone to making - and maintaining -
as few documents as possible.
France Telecom, Paris, France mailto:frederic -dot- wronecki -at- wanadoo -dot- fr
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-