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:Re: Can anyone suggest... From:"McDonald, Nancy (The Registry)" <McDonalN -at- LCI -dot- COM> Date:Wed, 25 Feb 1998 11:01:46 -0500
Kevin, which version of Word are you using? If it's W97, the callouts
are MUCh easier to use than the earlier versions. But here's what I
did with my User Guide Style Guide, which I created, with the ideas of
another Usability Engineer a few years ago.
In my doc, the first page has a list of these aspects:
1. Style Formats (headings, body text, list #, etc. from Word's
2. Layout (margins, page setup, etc)
3. Language & writing style
5. Index & TOC
1.1 Then I prepared a table for each category, eg, Style formats I
created a table with column headings:
Name/Based on/Following parag/Font/Parag/tabs/border/numbering. Then
I filled in the details for each style and each of those categories.
2.1 I then showed w/ some gfx what I wanted for the layout.
3.1 etc. etc. for each of the aspects.
Much of my style definitions came from the look of a MS Style guide,
and from format in MS user guides.
Hey all. I have a question for you. I am working on a style guide
my department. In Microsoft Word I have the styles listed in a table,
with a column for when each stlye should be used and a column
each style's attributes. Another tech writer in my department
that I make a sample document, using each style, and use call outs to
show how the styles are used and what each style should look like.
document, along with the styles would be placed on our department web
page. My question to you all is what program would be useful for
sort of thing, adding the callouts, that could easily be converted to
pdf for placement on our web page? Any suggestions, comments? Has
anyone tried this sort of thing before? Is it even possible? Any
comments, suggestions, etc. would be appreciated.