Software User Assistance Project Management
Tamara Ferris takes a look at a methodology for developing and
managing a Software User Assistance (UA) System, a way of doing things in a structured
manner. It provides a complete walkthrough for managers responsible for designing,
developing, and managing a software product’s user assistance system. The
software’s UA system could comprise of both paper-based user manuals and online help
systems. [Read More]
Your Search Engine Ranking
By David Leonhardt
There is a raging debate over the relative importance of on-page search engine
optimization and off-page optimization. This case study that offers presents some
intriguing findings. [Read More]
"5 Quickest Ways To Massive Windfalls Of Cash Online"
by Ewen Chia
These days everyone wants to know how to make money online. Yet, for some, this lifestyle
seems out of reach. Does this describe you at all? If you’ve been banging your head
against the wall trying to figure out the quickest and easiest methods to generate cash
for yourself online, then these five tactics should have you opening your eyes wide and
wondering: "Why didn’t I think of this before?" [Read More]
Beetle Bailey and Presentation Skills
By Larry Tracy
In March 2002, the comic strip Beetle Bailey contained a valuable lesson for business
presenters. As General Halftrack walked into his office, his secretary asked: "How
was Lt. Fuzz's presentation?" The General replied: "Like the Washington
Monument." Puzzled, the secretary asked, "The Washington Monument? General
Halftrack responded, "Yeah, it took a long time to get to the point." [Read More]
The Most Dangerous Letters in Sales are RFP
by Steve Waterhouse
So what's the solution? First, you must understand that the probability of
winning business from responding to an RPF where you have no relationship with the client
is so close to zero as to not be worth discussing. Unfortunately, everyone has won one or
two and believes that they are the exception. [Read More]
Web Writing: Create Writing Flow With Four UncommonConnectors
by Catherine Franz
Connectors -- conjunctions, punctuation, and transitional phrases -- allow readers to
process information promptly by creating balance and relationships between sentence parts.
The connectors are performing the same work as verbs,objects, modifiers and multiple
subjects. Here are four uncommon connections that will create an easier flow for your
readers [Read
More]
ESSENTIAL ELEMENTS OF A WRITING COURSE PROPOSAL
by Dr. Erika Dreifus
At some point in their careers, many writers may teach writing courses, either before a
“live” classroom audience or, these days, online. But how does a new teacher
develop that first course proposal? What elements should go into it?
[Read More]
The Beginner's Guide to Freelance Writing
by Jenna Glatzer
Okay. So youve figured out that you would like to write for magazines, newspapers, and
e-zines. Unfortunately, so have about eight gazillion other people on this planet.
Therefore, you have to stand out from the crowd. You have to sparkle. How do you do this?
[Read More]
Six Reasons You Don’t Need A Technical Writer
By Ann Zuccardy
Releasing a new version of your software? Developing a new product that needs a great user
manual? Who needs a writer; you can do the job with your existing staff, right? You might
be able to pull it off, but I’m willing to bet you’ll be happier with the
results and ultimately save money if you hire a technical writer at the start. [Read More]
Flowchart Tutorial
By EDraw Flowcharting Software
A flowchart is a diagram that uses graphic symbols to depict the nature and flow of the
steps in a process. Another name for this tool is flow diagram.
[Read More]
Some Important Tips On Proposals And Price
By Kris Mills
Here's a critically important copywriting technique I use when writing sales letters and
proposals for our own direct marketing services and for our clients.
It's all about "price". I see it all the time. And perhaps you do too. Letters
and proposals that bury the price at the very end of the document. [Read More]
Business Report Writing Tips
By Helene Malmsio
Let's assume that you have to write a document for work or study. Your instructions
consist of the title that you are to use and nothing else. Could you -- with only the
title as a guide -- write a suitable document?
[Read More]
Successful Documentation Projects – Part 1, 2 and 3
By Glenn Murray
The creation of user documentation is a big component of any software project.
Unfortunately, it’s often undervalued and left to the last minute. But that
doesn’t mean it should be without a good management plan. This is the first in a
series of three articles outlining the key elements of a good user documentation process.
[Read More]
Technical Writing for the Terrified
By Mike Kemp
Sometimes it may be beyond a companies or individuals budget to hire a professional writer
to address their technical documentation. Although in an ideal world all technical
documentation should be produced by a highly trained expert, unfortunately we do not live
in an ideal. [Read More]
UML Training - Avoid Analysis Paralysis!
By Francis Mosse
I've been in several situations in which students would stop me in a UML training class
and ask with stern faces: "How do you avoid analysis paralysis?" First time I
heard that I sincerely replied: "How do you get to be paralyzed?" Indeed, there
are many ways to avoid analysis paralysis-at least 5. [Read
More]
Essential Elements of a Writing Course Proposal
By Dr. Erika Dreifus
At some point in their careers, many writers may teach writing courses, either before a
“live” classroom audience or, these days, online. But how does a new teacher
develop that first course proposal? What elements should go into it? [Read More]
Software Development Project: Phases Overview
By Basil
Tesler
Most materials discussing the phases of a software development project are intended for
the developers community. I decided to take a different look at the issue and help those
novices who are going to outsource a software development project to an outsource service
provider (OSP). [Read More]
A Review of Error Messages
By Michael Bolton
"Error messages, if they’re posted at all,
should convey helpful information and advice--not only for the user, but also for tech
support and maintenance programmers. Here are a few things to think about when coding your
error-handling routines and designing your error messages." [Read More]
10 Tips for Aspiring Freelance Copywriters
By Glenn Murray
Every week I receive a couple of emails from people seeking advice on how to get into
freelance copywriting. While there’s no simple answer, and no answer which applies to
everyone, there are a few tips which I believe will help most people make the move into
freelance copywriting, and survive the first few months at least. [Read More]
9 Pointers for Evaluating a Business Proposal
By Ray Burton
Finding a business opportunity on the net is easy. But evaluating the right one for you,
takes a little knowledge. With so many scams, takers and failed ventures you need a little
more than the, "highest dollar for the least amount of work" approach. So what
should you look for when evaluating an opportunity? Here are 9 pointers. [Read More]
12 Tips for Generating Leads through Cold-Calling
By Glenn Murray
Cold calling can be a great way to generate quality leads. You get to speak to the
gatekeepers and stakeholders, and you get a great insight into their requirements and
influences. But cold calling is an art-form. It can be daunting, it’s always a lot of
work, and you always need to make a good impression. So you need to do it right. Following
are some tips which will help you do just that. [Read More]
Web Writing: Create Writing Flow With Four Uncommon Connectors
By Catherine Franz
Connectors -- conjunctions, punctuation, and transitional
phrases -- allow readers to process information promptly by creating balance and
relationships between sentence parts. The connectors are performing the same work as
verbs, objects, modifiers and multiple subjects. [Read More]
Beginner's Guide to Technical Writing
Articles on Technical Writing
Tutorials
Recommended Reading
Installation Programs
By Michael Bolton
Installation programs often fail to make a good first impression. Before you start
building your product, consider your installation program, the person who programs it--and
most importantly, your customer.
How I Became a Technical Writer
John L. Hoh, Jr. "In November 1994 I had an interview with Best Power in
Necedah, Wisconsin. I interviewed for a position known as “Technical Writer.
Basically, I saw the word “writer” and figured any other training I could pick
up. To be sure the day got off to an inauspicious start. When the interview was set up I
was told it would take several hours. I would be given tests during the interview." http://www.suite101.com
What does a Technical Writer Do?
"Technical Writers compose communication from product developers for users
of the products. Users include consumers as well as scientists, engineers, plant
executives, line workers, and production managers. Writers must write in a concise and
easy-to-read manner for consumer publications or in highly specialized language for
experts. With the increased use of desktop publishing, Technical Writers increasingly are
responsible for the publication process including graphics, layout, and document
design." www.calmis.cahwnet.gov
Guidelines for Better Writing
By Michael Bolton
Expressing your message clearly is easier if you follow a structure that helps to state
your point of view and build your arguments. Although good writing shouldn't be restricted
to a rigid format, here's a structure and some other tips that might help if you find
writing to be tough. [Read More]
The Hidden Cost of Buying
Information
Sean Silverthorne, Editor, HBS Working Knowledge
"We all need good information to make decisions—that is why consulting is an
industry that never goes out of style. But paying for information can carry a hidden cost:
We may give it more weight in our decision making than it deserves. That's one of the
conclusions made by Francesca Gino, a Harvard Business School post-doctoral fellow in the
Technology and Operations Management Unit." http://hbsworkingknowledge.hbs.edu
Usability: Lighting the Path to
the Future of Technical Communication
Anthony Torrence
"if you've ever talked to someone outside the field, whether friend or co-worker, the
question, "What is Technical Communication?" has come up. How do we answer this
question? Why is it important how, you might ask? Unless we know what Technical
Communication is how will we ever have a unified concept or theory to drive our
discipline? This paper, however, is not necessarily about defining Technical
Communication. I will explain through examining one sub-discipline of Technical
Communication, Usability, we may see an example of the beginnings of a pattern of
professional development." http://tc.eserver.org/orange/3-3/atorrence.html
Marketing Yourself as an
Independent Technical Writer
by Ron Kurtus
"Some technical writers go into business for themselves as freelancers or independent
contractors. A number of those become successful enough to form a writing company and hire
a staff of other writers. In either case, the technical writer who is in business for him-
or herself must continually perform marketing to maintain a steady income." http://www.school-for-champions.com
What Technical Writers are Paid
by Ron Kurtus
"The amount of money paid technical writers for their services varies considerably
with location. Writers in Northern California top the list with an average of $86,000 per
year, while writers in Wisconsin and Utah are at the bottom at an average salary of around
$48,000 per year. People interested in making technical communication as a career can use
this information as a guide in for what to expect in this industry. Present writers can
use the information to see where they stand in comparison to the norm." http://www.school-for-champions.com
Engaging and Educating Readers
Through a Progressive Writing
Jeanie Comstock
"Although technical communication documents cannot possibly be tailored to exactly
match the interest, reading level and many-faceted influences of a reader, they can I
believe, take measures to engage the reader to believe that the information he or she is
receiving from the document is valuable to their experience in some way. Jean-François
Lyotard in his essay, "The Postmodern Condition: A Report on Knowledge" writes
about the ownership of knowledge and how knowledge in modern society is being devalued and
that "use-value" of knowledge is diminishing in information distribution and
knowledge becomes a commodity." http://tc.eserver.org
Guidelines on Document Formatting
By Michael Bolton
In order to make sure that your document can be navigated easily, there are a few basic
features that it should include. [Read
More]
Parallel Lines
By Roy Peter Clark, Senior Scholar, Poynter Institute
"Writers shape up their writing by paying attention to parallel structures in their
words, phrases, and sentences. "If two or more ideas are parallel," writes Diana
Hacker, "they are easier to grasp when expressed in parallel grammatical form. Single
words should be balanced with single words, phrases with phrases, clauses with
clauses." http://www.poynter.org
5 Ways to Write Your Way into
Technical Writing
by Sean Hower
"Even with the technology market slowing down, there is still a need for quality
technical writers. Technical writers produce documentation that describe products or
services and explain how to use them. While this field may seem out of reach, becoming a
technical writer is pretty easy. There are five methods you can use to break into
technical writing:Get Educated; Get Technical; Socialize; Show Off; Pound the
Pavement." www.school-for-champions.com
Creating and Modifying Forms in
Microsoft Word 2000
"Many people use Microsoft Word as a glorified typewriter. That is, they
produce “one-off” documents. These are unique creations, such as a personal
letter, a report, or a chapter in a policy manual, intended for printing and sending to
someone. The original file may be saved on the author’s hard drive, but it is
unlikely ever to be used again. At the same time, we use many paper forms in our everyday
lives. Forms have parts that don’t change, and parts that are filled in with
different information every time they are used. Untold millions of paper forms are printed
and stored for use. They are frequently disposed of — unused — when the
procedure they support changes. As people have so often said, there must be a better way
to use trees." http://www.glencoe.com
Writing Guidelines for
Engineering and Science Students
"These guidelines for engineering writing and scientific writing are
designed to help students communicate their technical work. To that end, these guidelines
contain advice, models, and exercises for common writing and speaking assignments in
engineering and science." writing.eng.vt.edu
Functional Specification Tutorial
"Functional specifications (functional specs), in the end, are the blueprint
for how you want a particular web project or application to look and work. It details what
the finished product will do, how a user will interact with it, and what it will look
like. By creating a blueprint of the product first, time and productivity are saved during
the development stage because the programmers can program instead of also working out the
logic of the user-experience. It will also enable you to manage the expectations of your
clients or management, as they will know exactly what to expect." http://www.mojofat.com
Slides That Discuss Writing in
Engineering and Science
"This web page presents slides about writing in engineering and science.
These slides, which arise from The Craft of Scientific Writing and The Craft of Editing,
have been well received in writing courses for engineers and scientists at Lawrence
Livermore National Laboratory, Sandia National Laboratories, and several universities
including the University of Barcelona, the University of Texas, the University of Oslo,
and Virginia Tech." writing.eng.vt.edu
AmbySoft Inc. Coding Standards
for Java v17.01d
by Scott W. Ambler
"Because I believe in writing code that is easy to understand, to maintain, and to
enhance I decided that I needed to put together a standards and guidelines document for
Java coding. I also decided to share it with you, so here it is in its entirety for you to
download." http://www.ambysoft.com
Publishing Documentation in Microsoft Word -
Don't Do It!
Tanja S Rosteck. "To save costs, many small businesses take the do-it-yourself route
to publishing product and support documentation. The tool of
choice is often Microsoft Word - after all, you probably already have a copy of it and
know how to use it reasonably well. But while using Word to *develop* your materials is an
acceptable choice, using it to *publish* documentation is not! Read on to learn some of
Word's shortcomings as a publishing method, and what alternatives are available." http://www.suite101.com
Introduction To Process Patterns
by Scott W. Ambler
"This white paper, updated on June 1st, introduces the reader to the concept of
process patterns, reusable building blocks from which your organization may tailor an
object-oriented software process. Just as Design Patterns and Analysis Patterns brought
reuse and consistency to the OO modeling process, Process Patterns will bring reuse and
consistency to the entire OO software process (OOSP)." http://www.ambysoft.com
Layout Tips for Technical Papers
in Microsoft Word 2000
John Krumm, Microsoft Research
"The tips are written for someone with experience using MS Word who needs a boost on
the basic techniques for specific layout problems. In developing and documenting these
techniques, I have in mind a regular, technical conference paper with columns, equations,
and figures. There is an accompanying MS Word document that gives examples of these
techniques." research.microsoft.com
Does Editing Ensure Quality?
A discussion of the article “Technical Editing as Quality Assurance: Adding
Value to Content” in Technical Communication in which the authors argue that
technical editing is akin to software testing. http://www.stcsig.org/
Developing Author Guidelines
Gary Michael Smith: "Developing effective and usable instructions for
submitting manuscripts to periodicals is of paramount importance for expeditiously
handling and publishing peer-reviewed articles." http://www.stcsig.org
Choosing Authoring Software for
CD-ROM production
"One of the most important factors in the success of any CD-ROM project is
choosing the right authoring tool. Finding the most appropriate tool for your project can
make a big difference in achieving your goals. Conversely, using the wrong tool can result
in unnecessary delays and cost overheads that no project can afford. This article
describes how to choose a CD-ROM authoring tool."
More at http://www.documentation.com
Writing User Guides
"Designed for people who want to enter the technical writing field, this
course focuses on writing effective user (how-to) guides and gives an introduction to the
job of a user guide writer. Whether writing for the users of a company’s computer
system, for cashiers who need to know how to use a scanner, or for owners of a new
appliance, user guide writers are needed. And, writing for the end user is one way to
enter the technical writing field. Many writers start their jobs at companies maintaining
and creating end user materials." http://www.training-classes.com
Online Technical Writing
David A. McMurrey's excellent Online Technical Writing site is a must bookmark
for both novices and more experienced writers.
"You're probably wondering what this "technical
writing thing" is. Someone may even have told you, "it's this course where they
make you write about rocket science and brain surgery." Well, not really . . . .
Actually, the field of technical communications is a fully professional field with degree
programs, certifications, and—yes!—even theory. It's a good field with a lot of
growth and income potential; and an introductory technical-writing course for which this
book has been developed is a good way to start if you are interested in a career in this
field."
An enhanced hardcopy version of this online textbook entitled Power Tools for Technical
Communication by David A. McMurrey is available through
Thomson Learning/Heinle Publishers. or from Amazon.com. Recommended.
http://www.io.com
Checklist for Choosing a Training
or Documentation Vendor
"To find the right vendor when outsourcing a training or documentation
project, you need to do more than check the company's references and review samples of
their work. Take the time to do some careful probing and questioning. The cost of going
with the wrong vendor can be very high—in terms of money, time, and
frustration." More at http://www.documentation.com
Developing Successful Quick References
Karla Fitch from STC's Northeast Ohio Chapter highlights that, "In an age
when users have less time to understand increasingly complicated equipment, quick
references may be a technical communicator’s last great secret weapon. But what makes
a quick reference
successful?" http://www.stc.org
Free Online Writing Course
"Over time, I've come to know the problems people have in writing both
powerfully and correctly. I am continually writing to tell others how to correct those
problems. So I decided it would be to everyone's advantage for me to collect all that
writing and organize it into courses. People could deal with the common problems in their
writing and then use my paid services only when they had a manuscript that needed higher
level editing." http://www.writershelper.com
Writing Technical Articles
"The notes below apply to technical papers in computer science and
electrical engineering, with emphasis on papers in systems and networks. Give the paper to
somebody else to read. If you can, find two people: one person familiar with the technical
matter, another only generally familiar with the area." http://www.cs.columbia.edu
"What makes an award-winning document?"
by Rick Lorenz.
"The STC and ITE held a joint meeting at RMOC for a panel discussion on what makes an
award-winning document. For $8.00, I got a light dinner, and the opportunity to hear
expert opinions. Doreen deMunnik moderated the panel, which included Gordon Brown, Bob
Stanley, David Wegenast
and Paul Leroux." http://www.stceo.org
Getting Modular
by Rick Lorenz explains that "with modular documentation, modules/chunks of writing
can be reused. The philosophy is, "Write once. Use anywhere. This has a number of
advantages. The information is easier to update, and (with the right tools) every document
that uses the module can be updated automatically. Because modules are reused, the
documentation set is more consistent. Solution documents, which are custom made for
specific applications, are easily compiled from existing modules." http://www.stceo.org
Microsoft Word
|
Case Study Template
Pack