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:Lead-in to software documentation? From:Gunther Schmidt <g -dot- schmidt -at- bigfoot -dot- com> To:TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM Date:Mon, 26 Jun 2000 21:22:29 +0200
Techwhirlers,
I'm a technical writer in a German mechanical engineering company. A
new task contains a short software documentation which will be
printed. The software (which runs under Windows NT 4.0) is used to
control a video inspection system via keyboard and touchscreen.
Are there any web ressources for those who are new to software
documentation? I've heard of the Sun and Microsoft Style Guides and
the Chicago Manual of Style, but I assume that these are too detailed
for beginners. References on standards and some recommendations on how
to format the text for commands, messages, button descriptions, dialog
box entries etc. would be very helpful for me!
