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: Outlines and New FrameMaker Docs From:Benjamin Keevil <bkeevil -at- SYMPATICO -dot- CA> Date:Fri, 4 Jul 1997 18:05:52 -0500
Carolyn_Gillis -at- tvo -dot- org wrote:
>
<snip>
> Does anyone know where all the great outlining software of the late '80s,
> which helped fuel the small-computer industry, has gone? They were called
> "thought processors" for a good reason. I would have thought that they would
> be vital for creating complex technical documentation.
One reason why the "thought processor" applications are not used very much in the
90s may be that technical writers and computer users in general only have the
time and energy to learn 3 or 4 software applications. After learning Microsoft
Word, Excel, PowerPoint, Project, a Web browser, and for software writers the
program that you are documenting -- most human brains become overloaded.
In the early 80s, I used the More application (the productivity tool for the
successful Manager) on a Mac Plus and Mac II in a small 200-person division;
however, only 2 other people in the division used More. Everyone else used Word,
PowerPoint, and Project. Actually, I have an unopened, shrink-wrapped copy of
More in the basement along with a Mac 512 and Mac SE that someday I want to get
up and running again on the network.
Then from 1985 to 1996 I "graduated" to Interleaf running on a 20K UNIX system
and never needed any "thought processor" applications. However, in 1997 I moved
to a 3000-person division where most people use Microsoft Word, Excel,
PowerPoint, Project, and a Web browser. Then, I also wondered about using More
and order a demo of the Inspiration software (800-877-4292) but never had time to
evaluate it.
>
<snip>
>
> I wanted to begin large documentation projects with an Acta outline, save my
> Acta outline in .rtf format, and use FrameMaker to use my .rtf document for
> the beginning of a large user manual or documentation. I had hoped that FM5
> style sheets would have alowed me to convert my outline headers and text into
> Frame's headers, subheaders, and body text. The FM rep didn't seem to think
> so. If not, how would it be done?
>
For outlining large software documentation projects, I use:
1) - A Word or Frame template from a previous project -- add the headings and
generate a TOC that is distributed for comments and approval
2) - A document in simple HTML format (headings, paragraphs, and lists) that is
easily displayed in a browser for review and approval -- then cut and paste the
headings and points into a Word or Frame document (or HTML-based online help)
3) - PowerPoint as an outliner -- then cut and paste the headings and points into
a Word or Frame document
The template method works well because as you find the new technical info you
have a place to put it. The HTML method is a cross-platform solution because
every team member has a Web browser to view the outline. PowerPoint is a good
thinking tool and allows you to draw pictures (even mind maps) and display a
slide show that is a great method for determining the structure for new software
documents. Quite often I print 12 PP slides (6 to a page) on 2 handout pages that
allow me to "see" the document structure. The 2-page handout is also great for
presentations.
A few software developers used HyperCard and Silverrun to outline the
interactions among databases but these design documents were never kept up to
date.
In summary, based on my own experience, I think that most people just do not have
the time or brain power to effectively learn another "thought processor"
application particularly since the word processing and spreadsheet applications
are becoming so complicated.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
