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.
RE: About mil/heavy industries documentation standards (long)
Subject:RE: About mil/heavy industries documentation standards (long) From:eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com To:Daniel_Hall -at- trendmicro -dot- com Date:Thu, 12 Feb 2004 13:05:44 -0500
Daniel_Hall -at- trendmicro -dot- com wrote on 02/12/2004 12:54:47 PM:
> Hmmmm... is there a third choice? :-)
> Dan
Actually I see three other possibilities:
1 - Mechanic follows poorly formatted but perfectly complete and well
structured manual to the letter like a noob, but progresses steadily.
2 - Mechanic follows beautifully formatted manual using stylistic
fonts/typography and wonderful use of whitespace and page design. But, is
finished very quickly and doesn't seem to check most of the parts and
final product seems to be somewhat peculiar compared to an untouched unit.
3 - Mechanic performs maintenance with perfectly designed and fully
complete manual set. But, due to non-standard organisation, spends hours
scratching their head looking for information. The disorganisation causes
many steps to be omitted and the mechanic to give up in frustration or
finish the incomplete job in a rush.
Conclusion:
Good looking documents are only an improvement once the information is
correct, complete, and well organised. Only then should font size become a
preoccupation.
