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.
> I have been asked to reformat an existing Application
> Developer's Guide
> (written by programmers). Because this is a first for our
> company and for
> me, I would really appreciate any suggestions or samples you may have.
Could you be a bit more specific? What kind of suggestions are you looking
for exactly? Formatting? Grammar? Style? Voice?
You might want to check out the Microsoft Manual of Style and take the
guidelines you like. Maybe they'll inspire you to add your own personal
flair to the manual!
Take a look at some of the other manuals out there on the market and see how
they formatted their manuals.
My own suggestions would be: use a Serif font for body text (like Book
Antiqua or Times Roman) and use a Sans-Serif font for titles (headings) and
for a special terms in your body text (with some bold thrown on top of
that).
But again, tell me exactly what you're looking for and I'd be glad to make
more suggestions (a captive audience!).--
Be seeing you,
Dave
---------------------------------------------
John David Hickey
Montreal, Quebec, Canada eh?
No trees were harmed in the writing of this email.
My emails are made from elephant tusks and dolphin meat.
---------------------------------------------
Don't confuse my opinion with my employer's.
Each exists in blissful ignorance of the other.
