Tech Writing Brief

A user guide, also commonly known as a manual, is a technical communication
document intended to give assistance to people using a particular system. They are
written by a technical writer.
User guides are most commonly associated with electronic goods, computer
hardware and software.
Most user guides contain both a written guide and the associated images. In the case
of computer applications it is usual to include screenshots of how the program should
look, and hardware manuals often include clear, simplified diagrams. The language is
written to match up with the intended audience with jargon kept to a minimum or
explained thoroughly.
Contents
The usual sections of a user manual often include:
A preface, containing details of related documents and information on how to best

use the user guide
A contents page
A guide on how to use at least the main functions of the system
A troubleshooting section detailing possible errors or problems that may occur along
with how to fix them
A FAQ (Frequently Asked Questions)
Where to find further help and contact details
A glossary and, for larger documents, an index
Quick Reference Cards
Quick references come in many different shapes and sizes, including slide
rules, posters, templates, wallet cards, stickers/magnets,
pamphlets/brochures, reference cards, and small-format booklets. (For more
information on these formats, see the sidebar “Quick Reference Guide to
Quick Reference Accessibility.”
As tools and toys become more hightech, it’s sometimes important to give
users just enough information to operate them successfully and safely.
Relevant, brief, and accessible quick references can provide a welcome
solution to this problem.
Like any documentation product, quick references require a thorough
audience analysis and a good grasp of the information needed to help users
perform tasks safely. Armed with this information and an understanding of
the keys to crafting a successful quick reference, technical communicators are
well equipped to deal with the challenges of providing just enough
information, at the right time, in just the right way.
What Is A Functional Specification?
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.
Why write a Functional Spec?
A key benefit of writing up a Functional Spec is in streamlining the

development process. The developer working from the spec has, ideally, all of
their questions answered about the application and can start building it. And
since this is a spec that was approved by the client, they are building nothing
less than what the client is expecting. There should be nothing left to guess or
interpret when the spec is completed...and this, in a nut, explains my love
affair with the Functional Spec.
Why should I consider FrameMaker?

Adobe FrameMaker is a rich application with many capabilities. The following
is not a complete list of capabilities, but are some of the key requirements
that Adobe FrameMaker meets. You might consider unstructured FrameMaker
if:
Your primary information delivery format is print or PDF (printed or delivered
online).
You need support for single-source publishing, for multiple related documents
and/or multiple output formats.
Your documents include complex tables, graphics, cross-references, and
complex numbering.
Your documents tend to be large and are difficult to maintain (due to system
crashes and file corruption) in other authoring applications.
You need to create multiple documents with identical formatting (for example,
a documentation set for a complex product).
Why should I consider structured FrameMaker?

Structured FrameMaker offers all of the capabilities of unstructured
FrameMaker. In addition, it meets the following additional business
requirements:
You need to create XML but want to work in a familiar authoring environment
without dealing with the minutiae of XML syntax.
You need to enforce a consistent structure within and across documents.
You need a guided editing interface to support authors in creating valid
structured and/or XML documents.
You need to create valid XML documents because of your publishing
requirements, customer requirements, or content management needs.
You need to publish print or PDF documents from XML source files.
Conclusion
XML-based publishing can substantially improve an organization’s capabilities

for delivering its user assistance in multiple formats to multiple devices, and
to manage that content for reuse. Although substantial effort is required for
any XML publishing project, the return on investment can also be substantial.
For organizations seeking to create and edit content in XML, structured
FrameMaker is a capable authoring tool, that has the added advantage of
being familiar to many technical writers. Structured FrameMaker’s guided
editing and validating capabilities can even provide benefits to organizations
that aren’t immediately migrating to XML, but wish to improve the
consistency between documents in content and structure.
Why DITA? (http://dita.xml.org/why-dita)
For some, perhaps the real question is Why XML? (or What is XML?), but
assuming you have answered those questions (and are using XML), then the
next step is to locate an appropriate data model for your content. This is an
important step because you will spend a lot of time and money developing
processes and selecting tools to support your chosen data model. XML, by
definition, is extensible and allows you to create any valid structure that suits
your needs, but before you decide to develop your own, consider the pre-
existing options (see Don't Invent XML Languages for a discussion on why not
to develop your own). If you can leverage and build on top of someone else's
work, why not?
DITA is a data model for authoring and publishing topic-based content. It was
developed by IBM for internal use and has since been released to the open-
source community (now under the guidance of OASIS). This architecture and
data model were designed by a cross-company workgroup representing user
assistance teams working throughout IBM. After an initial investigation in late
1999, the workgroup developed the architecture collaboratively during 2000
through postings to a database and weekly teleconferences. Since that time
IBM has migrated thousands of pages of content to DITA.
But, why DITA?
Well, assuming your content fits into the topic-based data model, DITA's
increasing popularity means that more and more authoring and publishing
tools will be developed to support that model. The DITA Open Toolkit allows
you to generate many popular output formats (HTML, HTML Help, PDF, Java
Help, etc.) from DITA-based content. If you develop your own data model,
you'll have to pay to develop those transformations. DITA's modular
architecture, supports efficient reuse of content at the word, phrase or topic
level. DITA also has the concept of "specialization," which allows you to
develop elements of your own that are based on core DITA elements. This
helps you to customize DITA to support your particular types of content while
continuing to take advantage of the base DITA tools and transformations.
Why Author-it?
Complete - Author-it is a complete end-to-end solution for authoring,
managing, localizing, and publishing content to multiple outputs
True Single Sourcing - one source for all content, allows reuse of any
component
Proven - Author-it is already implemented in thousands of sites, including
many Fortune 100 organizations, in over 50 countries
Collaborative - allows authors and other contributors work together as a team
Dependable - Author-it is built on reliable, scalable, open technologies, like
XML, .Net, and relational databases
Achievable - Author-it ships enterprise-ready; Author-it is built from the
bottom up to be scalable.
A Content Management System (CMS) is a software system used for

content management. Content management systems are deployed primarily
for interactive use by a potentially large number of contributors. For example,
the software for the website Wikipedia is based on a wiki, which is a particular
type of content management system. For the purposes of this page, Content
Management means Web Content Management. Other related forms of
content management are listed below.
The content managed includes computer files, image media, audio files,
electronic documents and web content. The idea behind a CMS is to make
these files available inter-office, as well as over the web. A Content
Management System would most often be used as archival as well. Many
companies use a CMS to store files in a non-proprietary form. Companies use
a CMS to share files with ease, as most systems use server based software,
even further broadening file availability. As shown below, many Content
Management Systems include a feature for Web Content, and some have a
feature for a "workflow process."
"Work flow" is the idea of moving an electronic document along for either
approval, or for adding content. Some Content Management Systems will
easily facilitate this process with email notification, and automated routing.
This is ideally a collaborative creation of documents. A CMS facilitates the
organization, control, and publication of a large body of documents and other
content, such as images and multimedia resources.
A web content management system is a content management system with

additional features to ease the tasks required to publish web content to web
sites.
List of CMS
Fedora (Supported Databases – MySQL or Oracle)
Joomla! (Supported Databases – MySQL)
Documentum (Supported Databases – Microsoft SQL server , IBM, DB2)
Today's content management systems are elaborate software/database

applications designed to store and process large amounts of complex
information.
Any application which manages information could technically be considered a

CMS, such as Help Desk software, Address/contact management systems,
web blogs, etc. However, a classic content management system is
generally regarded as a framework of tools that are less application or
data-specific.
A Help authoring tool or HAT is a software program used by technical

writers to create online Help.
Some common Help authoring tools include:
Doc-To-Help: An authoring tool based on Microsoft Word.
Adobe FrameMaker: The most common tool for large technical documents.
Requires other tools to convert content to online Help.
Microsoft HTML Help SDK: A collection of tools for creating files in
Microsoft's HTML Help format.
Macromedia RoboHelp: A specialized tool for creating online help.
Microsoft Word: Widely used for technical writing despite its limitations.
Requires other tools to convert content to online Help.
Epic Editor: An XML-based authoring tool.
Microsoft Visio: Software for creating diagrams.
Webworks Publisher: Converts documents in various formats to other
formats, primarily HTML.
AuthorIT: A collaborative authoring tool used for single-source content
management.
Republicorp XDK: An XML, HTML, and Help toolkit based on Microsoft Word.
Technical Writing Process
Know your audience

Who is the reader?
How much information does the reader need?
What is the reader’s present knowledge base?
What will the reader do with the information?
What are reader’s sensitivities?
What are the reader’s biases?
How much time does the reader have to read?
Gather Information
Key to gathering information
Interviewing skills
Reading skills
Networking skills
Interpersonal relations
Brainstorm Information
Gather as much information as possible
Keep a free mind and do not monitor the order of your thoughts.
Let thoughts flow. Jot them down or type them in the order as they come.
Accepts words, phrases or complete thoughts.
Do not attempt to group or arrange information.
Do not restrict yourself to the format or grammar of the ideas.
Categorize & Organize Information
Gather information
Jot down topic headings (Random Order)
Delete irrelevant topics
Group related topics
Arrange topic headings
Pyramid Writing Technique
Organize Information
Pick a pattern
Chronological
Psychological
General to specific
Problem to solution
Whole to parts
Most important to least important
Comparison/ contrast
Cause/ effect
Spatial
Design Document
Use an abstract, TOC or other front matter elements
Use vertical lists
Use enumerated lists
Use visual elements
Write shorter sentences
Use headers and footers
Paragraph more frequently
Break information into sections/ chapters
Use more white space
Use two column format
Use ragged right text, instead of right justified text
Write Document
Write section by section
Write only, and not revise as you write
Be yourself. Don’t mime the style of “experts”
Use simple words/ sentences
Keep sentences short
Repeat nouns to avoid ambiguity
Don’t be afraid to fail
Revise Document
Use simple words/ avoid euphemism
Use short sentences
Use bias free communication
Use active voice extensively
Use passive voice appropriately
Write numbers in narrative appropriately
Write abbreviations appropriately
Maintain parallel construction
Keep text concise
Keep to the subject
Check spellings (UK, USA)
Check capitalization and punctuation
Avoid low information contents words/ redundant words.
Avoid vague words/ abstract expressions
Avoid negative constructions. Use only when necessary.
Avoid inverted word order
Use simple words
Monitor use of
Jargon
Euphemisms
Acronyms
Neologisms
Bias free communication
Avoid bias regard to
Gender
Race
Ability
Active and Passive Voice
Use passive voice
when actor is unknown
as a tool for tactful expression
to emphasize certain words or group of words
Writing Numbers
Basic rule
Spell out single-digit numbers (one to nine inclusive)
Use figures for multiple-digit numbers (10 and above)
Exceptions to this rule exist….

Abbreviating Terms
Centimeter cm
decibel dB
cathode-ray-tube crt
singular sing.
meters m
hours h or hr
Exceptions
morning a.m.
Inside diameter ID
number(s) No.
The three basic rules are
Use lowercase letters, unless abbreviation is formed from a person’s name
Omit all periods, unless abbreviation forms another word
Write plural abbreviations in the same form as the singular abbreviation.
Do not create abbreviations when standard one already exists
Parallelism
Low information content words/ redundant words
Vague words/ abstract expressions-eg.
Abstract-While the crew was in town they picked up spare parts.
Concrete-While the crew was in town they bought spare parts. OR While the
crew was in town they stole spare parts.
Abstract-The project will take a long time.
Concrete-The project will require 300 work hours. OR The project will last four
months.
Negative Construction
Positive
Save your work, and then turn off your computer.
It is possible to lose all your work, so back it up to be safe.
Negative
Do not turn off your computer without saving your work.
It is not impossible to lose all your work, so back it up to be safe.
Inverted word order
Before you may begin using the system, you must “log on” to it.
In addition to its command processing functions, another feature of the shell
is its programming capability.
Log on to a system before using it.
The shell has command processing and programming capabilities.
What is Information Mapping?

Information mapping is a technique of dividing and labeling information for
easy comprehension, use and recall. It was developed by Robert E. Horn.
Information Mapping is a structured approach to creating clear, concise and

highly usable information focused on the target audience. It does this through
analysing, organising and presenting the information based on audience
needs and the purpose of the information. Information Mapping is both
subject matter and media independent.
Horn and his colleagues identified dozens of common documentation types,

then analyzed them into structural components called information blocks.
They identified over 200 common block types. These were assembled into
information types using information maps.
The seven most common information types were concept, procedure, process,
principle, fact, structure, and classification.
These types are loosely related to the three basic information types in Darwin
Information Typing Architecture - concept, task, and reference. An
Information Mapping procedure is a set of steps for a person. A process is a
set of steps for a system. Both resemble the DITA task.
DITA topics (concept, task, and reference) are assembled into documents
using DITA maps.
What is XML?
XML stands for EXtensible Markup Language

XML is a markup language much like HTML
XML was designed to describe data
XML tags are not predefined. You must define your own tags
XML uses a Document Type Definition (DTD) or an XML Schema to describe
the data
XML with a DTD or XML Schema is designed to be self-descriptive
XML is a W3C Recommendation
XML was designed to carry data.
XML is not a replacement for HTML.

XML and HTML were designed with different goals:
XML was designed to describe data and to focus on what data is.
HTML was designed to display data and to focus on how data looks.
HTML is about displaying information, while XML is about describing
information.
It is important to understand that XML was designed to store, carry, and

exchange data. XML was not designed to display data.
Enterprise Resource Planning systems (ERPs) integrate (or attempt to
integrate) all data and processes of an organization into a unified system. A
typical ERP system will use multiple components of computer software and
hardware to achieve the integration. A key ingredient of most ERP systems is
the use of a unified database to store data for the various system modules
Ideally, ERP delivers a single database that contains all data for the software
modules, which would include manufacturing, Supply Chain Management,
financials, Accounts, HR, CRM. ERP vendors are SAP, Oracle Corporation,
PeopleSoft.
API Documentation Tutorial
In this tutorial, I will focus on the basics of an API function.
What is an API?
An API (Application Programming Interface) allows programmers to access

and extend the functionality of a program through well-defined data
structures and subroutine calls.
Take Windows as an example. Let us say you want to change the double click
time for the mouse. How will you accomplish this? You accomplish this
through a Windows API function called SetDoubleClickTime. Windows
provides this specific API function for setting the double click time.
Collections of API functions constitute the Windows API.
What comprises an API function?
Examining our example API function SetDoubleClickTime we find that the

API function comprises of a single Integer parameter called uInterval as
input to the API.
This API function also returns a Boolean value indicating whether the API
function call was successful or not.
Every API function consists of certain parameters as input to the API function
and certain parameters that the API function returns as output.
Where does the API function reside?
An API function definition always resides in a Header file along with various other
function definitions. Our API function definition SetDoubleClickTime resides in a
header file called Windows.h. Collections of these header files are usually made into dll files
on Windows (or .so files on Unix) along with other files that contain the compiled code for
these functions, and are categorized according to the functionality they provide. Our specific
header file Windows.h resides in a dll called user32.dll. These dll files are shared, so that
many programs can make use of them without every program having to have their own copy.
Documenting an API
When documenting an API, the following points must be covered:
Name and Purpose of the API function

Name of the header file it resides in
Input parameters and their types
Return parameters and their types
Any issues to be aware of when using the API function
Example code showing how to use the API function
Let us document our example API function:
Name: SetDoubleClickTime
Purpose: The SetDoubleClickTime function sets the double-click time for the mouse.
A double-click is a series of two clicks of a mouse button, the second occurring within
a specified time after the first. The double-click time is the maximum number of
milliseconds that may occur between the first and second clicks of a double-click.
Header file: Windows.h in user32.dll
Input Parameters: (1) uInterval of type Integer. This specifies the number of
milliseconds that may occur between the first and second clicks of a double-click. If
this parameter is set to zero, the system uses the default double-click time of 500
milliseconds.
Return Parameters: The return value is a Boolean. If the function succeeds, the
return value is non-zero. If the function fails, the return value is zero.
Issues to be aware of: None
Example:
This example is ONLY meant to illustrate the fact that an example use of the API
function needs to be present in the documentation. Please do NOT take this example
code literally as it may NOT be syntactically perfect. Write your own proper example
code pertaining to what you are documenting.
I understand that the code is NOT formatted properly. However, this is a limitation
of BB Code.
#include "windows.h"
int main(int)
{
int dblclktime;
bool rtnval;
dblclktime=300;
rtnval=SetDoubleClickTime(dblclktime);
if (rtnval==0)
{
printf("Call Failed");
}
else
{
printf("Call Succeeded");
}
return 0;
}
Are You Ready for an Unexpected Job Interview?
Most job seekers wait to polish up their interview skills until they are looking for a
new position. Important interview opportunities, however, can present themselves
at any time. For example,
Unplanned internal job openings: There is a sudden opportunity to

advance your career from within, and your boss recommends you as a
candidate for the job. ARE YOU READY TO COMMUNICATE YOUR
CONTRIBUTIONS TO THE COMPANY?
A recruiter calls: The position sounds like just the career move you’ve been
wanting. WILL YOU SAY THE RIGHT THINGS TO WIN THE JOB OR WILL YOU
BLUNDER YOUR BEST CHANCE?
A former colleague introduces you to his boss: They are building an
exciting new division for their company and looking for new staff. CAN YOU
ENTICE HIS INTEREST IN YOU AS A MUST-HAVE NEW TEAM MEMBER?
Those who continually grow in their careers are always prepared for these
situations. Their interview skills are sharp at all times. To know if your skills are
sharp enough to handle a surprise interview, see if you can answer the following four
questions:
1. Can you concisely state your value proposition in 30 seconds or less?
A value proposition is meant to intrigue your listener with a quick overview of your
skills, expertise, and industry know-how. If you can offer a precise summary of why
you are the perfect candidate for that job, you are more likely to get to the second
or third interview. A concise value proposition can make a critical difference in
winning you a new position.
2. Do you know your top five accomplishments, and can you communicate their
impact to your employer’s bottom-line initiatives?
A list of your top accomplishments will allow a potential employer to imagine what
you can do for him or her. Accomplishments give employers a way to associate your
skills with their needs—and a reason to remember you. Be prepared to list your top
skills and show how they can help meet corporate needs.
3. Are you prepared to answer your own toughest interview questions or do you
hope they just won’t come up?
Don’t leave yourself vulnerable to questions like “If you’re doing so well in your job,
why do you want to leave?” A good recruiter or hiring manager will see you sweat
and stutter and squirm; you’ll lose their confidence and destroy a chance to get your
dream job. Think about the questions that will be your biggest pitfalls—and be
prepared to answer them.
4. Do you know how to find out your interviewer’s motivations to understand how
best to answer their questions?
This is a very important question. Without knowing your interviewer’s motivations,
how will you know if your answers hit the mark of what he or she is looking for in a
perfect candidate? There are many ways to conduct research discreetly and
determine exactly what that employer needs. Once you have those answers in hand,
you can target your interview answers accordingly.
A good career coach can help you answer all these questions and more, preparing
you for the interviews you plan—and the interview you didn’t expect. With those
answers in hand, you can take your career from mediocre to marvelous with
“always-ready interview skills.
Be prepared to answer these questions:
How would you best describe yourself?
What is your major achievement: professional and personal?
Why would you like to leave your current organisation?
How do you see yourself five years down the line?
I hope to look back and see that I made a difference".
What is your career objective in the years to come?
I would say I would like to see myself as a Manager/Director/VP or the designation of the
interviewer or his boss depending upon what level you are being interviewed for. This will
bring a laugh/smile on the face of the interviewer and the situation a little light. Now is
the time to tell your aspiration, I would say, "coming back to your question, i would like
to take one step at a time and gradually see myself in a position which has much more
responsibility. A role which will help me contribute directly and positively to the
organizations growth. A role which will help me guide and mentor future aspirants to be
successful in their tasks. A role which will help me align the teams objectives to the
organizational goals. I wud use one/all to make my case.
What are your weaknesses?
I would say the following two to be my weaknesses (a) My weakness is that i am a little
too perseverant (b) I like to strike relationships with absolute strangers (c) I am a patient
listener. All these qualities are truly a must for any sales guy. So it works in your favor.
“What is more important to you, the money or the job?” Great, if I say “the money,”
the hiring manager doesn’t think I’m motivated to do the work. If I answer with “the job,”
the manager doesn’t think I’ll be upset with a smaller salary offer.
I most likely would respond (if i ever chose to actually seek employment LOL!), that money is
important as it is an essential element when shopping for food. But from my experience,
money is not a longevity factor if the job is not challenging or if the work environment is not
conducive to complementing one's life's goals. Then i go on to say what the happy medium
would be.... The nirvana-like situation would be one in which the company recognizes what i
bring to the table, utilizes various parameters such as realistic cost of living factors, my
experience, industry-wide market value combined with challenging projects, autonomy,
integrity, respect, sprinkled with a dose of laughter.
“Do you prefer to work alone or with others?” Swell, I can like to work by myself and be
thought of as a poor team player with no collaborative abilities, or else I work so well with
others I can’t get anything done by myself.
. But I like working with people to brainstorm ideas, help get better solutions to problems
and help others for what they need.” And if saying yes to all options doesn’t work? Then
there is an alternative:
A second way to answer the forced choice is to pick a third option that isn’t presented
by the interview question. “Do you work better with a manager that gives you free
reign to complete your work the way you want or do you like being micromanaged to
get your work done?”
For that type of question, you ignore both options presented and offer up a third
alternative to answer this question. “I like a manager that provides clear direction, is
open to seeing early versions of the work so we can make sure I’m on track, and to
help clear obstacles that might prevent me from getting done.”
Checklist
How to Shape Your Personal Brand on LinkedIn

• Seek out recommendations from past bosses, key clients, colleagues, and
direct reports to create a 360-degree picture of your strengths. Tell them that
you’ll be happy to do the same for them.
• Instead of a generic job title at the top of your profile, such as “Owner of John
Doe and Associates,” use a short description of valuable credentials that you
can quantify, such as “20-year veteran of $100 million in high-tech mergers,”
advises Chris Muccio, author of the book 42 Rules for 24-Hour Success on
LinkedIn.
• Fill out the “Interests” section with pursuits, such as charitable projects, that
reinforce your value to potential employers and clients.
• For consistency and branding, use a good head shot of yourself as your
photo, and use the same photo on other social networks, advises Megan
Hendricks, director, employer relations at the College of Business at the
University of South Florida.
• Opt for a free vanity address for your profile that uses your full name, such as
linkedin.com/in/janedoe, so colleagues can find your profile easily.
Is your resumé the key to a higher salary?
Most job seekers believe that salary negotiation starts once they have an offer in
hand, but nothing could be farther from the truth. In fact, your resume can make
the difference between negotiating at the top end of the salary range—or the bottom
end—in your next job offer. If that sounds strange to you, consider the following
points:
A prospective employer’s first impression of you is created entirely by your resume.
The employer’s first impression of you will assign a value and build a level of urgency
for the employer to contact you—before someone else does.
First impressions are nearly impossible to change.
If your resume sells your skills short, then you can’t expect to receive offers at the
upper end of your salary scale. Your current resume could be losing you thousands
of dollars in income power. By making a few key changes in your resume now, you
can position yourself for higher salaries in the future.
There are three resume strategies for promoting high salary negotiation success:
Show that you are a high return on investment with quantifiable results.
Many job seekers throw around the phrase “results oriented”, but they fail to back it
up with concrete evidence—leaving the reader to conclude otherwise. You may feel
that you have no quantifiable evidence of your value in previous jobs, but every job
has quantifiable results that can better reflect your worth on your resume. Revenue,
sales dollars and material costs are not the only results that use numbers.
Consider using the number of man-hours saved in process improvements, the

percentage of repeat customers, or the number of peers helped by a particular
efficiency to help reflect your abilities. Every employee is hired to solve problems,
and most problems have some quantifiable element at their core.
Illustrate the breadth of your experience.
Notice the use of the word “breadth” rather than “length” of experience. Just
because a candidate has been doing a job for a long time does not necessarily mean
he is worth more. Breadth of experience focuses on quality, not quantity.
There are two key ways to express breadth of experience:
Industry knowledge
Since industry expertise is usually in high demand, you can show your value through
insider understanding of industry issues.
Transferable skills
If your career spans many industries within the same occupation, highlight the
transferable skills that have enabled you to bridge the gaps from industry to
industry.
Entice the reader to want to know more about you.
Job seekers often make the mistake of assuming that the job of their resume is to
inform the reader. Not so! The ONLY job of your resume is to entice the reader to
want to know more about you.
What that translates to is an understanding of what to include and what to leave off
your resume. Too much detail can distract the reader and lose his interest, but not
enough information, and the reader will wonder what you have been doing with your
life. A proper balance between detail and result will win the reader’s interest and
leave them saying, “I’ve got to call this guy for an interview today!”
A professional resume writer can create a resume that sells you as a high return on
investment. By portraying you as someone with great breadth of experience and a
wide range of critical skills, potential employers will see you immediately as someone
of high value, building their vision—and your self-confidence—of you in the upper
end of the salary scale.
For fast job search results, make sure to avoid these top three cover letter mistakes:
1. Not understanding the hiring motives of your audience

2. Repeating rather than introducing your resume
3. Overuse of the word “I”
Differentiate b/w project & product
A product is an artifact that is produced, is quantifiable, and can be either an

end item in itself or a component item. It can be a service, a business
function supporting production or distribution. It can be a result such as,
outcomes or documents. For e.g. a research project develops knowledge that
can be used to determine whether or not a trend is present or new process
will benefit a society.
A project is a temporary endeavor undertaken to create unique deliverables

which are products, services, or results. Projects are not ongoing efforts. It
has a definite beginning and an end. Once the objectives of a project are met,
the end is reached.
What is LMS?
A learning management system (LMS) is software for delivering, tracking and
managing training. LMSs range from systems for managing training records to
software for distributing courses over the Internet and offering features for
online collaboration. In many instances, corporate training departments
purchase LMSs to automate record-keeping as well as the registration of
employees for classroom and online courses. Student self-service (e.g., self-
registration on instructor-led training), training workflow (e.g., user
notification, manager approval, wait-list management), the provision of on-
line learning (e.g., Computer-Based Training, read & understand), on-line
assessment, management of continuous professional education (CPE),
collaborative learning (e.g., application sharing, discussion threads), and
training resource management (e.g., instructors, facilities, equipment), are
dimensions to Learning Management Systems.
Most LMSs are web-based to facilitate access to learning content and

administration. LMSs are used by regulated industries (e.g. financial services
and biopharma) for compliance training.
What is your specific interest in technical writing?
Why do you think they want to work with us?
What sort of work culture do you expect in their workplace?
What are your long-term goals? What do you see themselves in 3-5 years
time
What is a White paper?
White papers typically, are authoritative reports or guides used to educate

readers and help people make decisions. Commercially, a white paper is used
as a marketing or sales tool. Many white papers today reveal the benefits of
particular technologies and products. White papers are almost always,
marketing communications documents designed to promote a specific
company's solutions or products. Such white papers are often used to
generate sales leads, establish thought leadership, make a business case, or
to educate customers. White papers should:
• Begin by addressing problems, challenges, or needs, rather than the
solution
• Range from 5 to 12 pages in length, on average
• Educate as a top priority
• Avoid direct selling
• Focus on benefits more than features
• Contain information useful to the readers
• Avoid the sense of humor
In the following sections discussing the components of this technical writing, the
term ‘the white paper company’ refers to the company you are describing (or
working for) in the white paper. ‘The target company’ refers to who you expect to
read the white paper and be persuaded by it that ‘the white paper company’ is who
they need to do business with.
Include the following in your white paper:
• Problems and issues currently affecting the market and industry. First thing,
briefly discuss what the target company is dealing with – competition,
financial issues, economy, laws, etc – that could impact them negatively. Let
them know that the white paper company has an intimate knowledge with
what they’re going through.
• Solutions to each problem and issue. The point of bringing up the problems is
to explain how the white paper company can provide solutions for the target
company. Discuss how the white paper company can turn each problem,
issue, or threatening trend into a positive source of income.
• Description of solution aspects. If, for example, the white paper company
provides system databases, then describe the technology behind their
particular system database solution. Don’t lose the target company because
the CO reading the paper doesn’t understand how the technology works.
However, if everything is standard and basic, don’t waste time re-defining the
obvious.
• Show how the white paper company will serve the target company in
particular. Specifically apply the white paper company’s solution to the target
company’s problem. Why is the white paper company better than its
competitors? Why should the target company choose them? Why now?
• Examples, benefits, case studies. It’s more of the same but a thorough
example of how another company benefited from utilizing the solution
suggested. Outline what specific things the target company has to gain.
• Graphics, charts, images. Anything to make it even more clear in eye popping
color what exactly it is that the target company is missing and how the white
paper company can fill that hole. Visual effects are more memorable and
stand out on the desk top better than plain text.
• Give a list of companies with whom the white paper company could create a
partnership with in order to benefit the target company. If, for example,
another company makes a certain software that would be perfect for the
target company’s needs if combined with the white paper company’s product,
then that company would be on the list with a brief description why.
• Summary. This is the last thing on the white paper and is usually a bullet
point summation of everything you wrote. It may feel like you’re writing and
re-writing the same information and, in a way, you are. But each section adds
more dimension and with repetition comes persuasion and clarity.
Resume Samples
Samples represent that of an actual working technical professional found on

the WEB and modified to protect the privacy of these professionals. Human
names, company names, colleges, software product names are intentionally
made up.
Resume 1
Samples represent that of an actual working technical professional found on the WEB
and modified to protect the privacy of these professionals. Human names, company
names, colleges, software product names are intentionally made up.
RANDOLF J. KWAN
250 LANCASTER STREET
UNION CITY, CA 95843
OBJECTIVE
SR. TECHNICAL WRITER
ILLUSTRATOR - CURRICULUM DEVELOPER - TECHNICAL TRAINER
QUALIFICATION SUMMARY
Over 20 years experience with analog/digital systems from technician to

engineer at increasing levels of responsibility. Developed and supervised a
variety of technical projects including:
Training and technical documentation programs.
Developing training curricula for various technical subjects both informally

and in a classroom setting.
Designing fault-isolation procedures and related reference materials.

Development of documentation and templates in Framemaker+SGML.
Scripting interactive on-line help and tutorial packages.
Installation and maintenance of computer, security, and

telecommunications systems.
SKILLS
Excellent oral and written communication skills.

Extensive Computer and Technical Skills including:
Page layout, desktop publishing, illustration, animation, on-line
documentation and editing.
Development of standard operating procedures and new user training.
Practical experience in data conversion across a variety of platforms Apple,

PC, UNIX, and others .
Ability to interpret schematic diagrams, and other source materials.
Ability to read software code, as source materials, in a variety of languages.
Ability to work independently and as a team member.
Supervisory skills including the ability to:
Communicate well with co-workers, management, and outside vendors.
Edit the work of others in a constructive and non-ego-bruising manner.
Analyze projects and quantify them into tasks and budget requirements.
Independently plan and monitor projects, ensuring timely and cost efficient
task completion.
Make work assignments and gauge individual progress.
ACCOMPLISHMENTS
While in sole charge of a technical publications department, instituted

production and tracking methods, which yielded a time and cost reduction
of over 30. This greatly improved document technical content and quality.
Developed database system, which tracked engineering changes and

ensured that hardware and software changes were accurately reflected in
updates to user publications. This greatly reduced the shipment of outdated
documentation to end-users.
Developed a database tracking system that matched student entry-level

knowledge and skills with those demonstrable after training. The
application of this system resulted in the shortening of training courses by
one week 17 and improved student retention by 22 avg.
Developed authoring system for computer laboratory training scenarios,

which allowed instructors to reduce the time required to tailor daily lab
simulations to the needs of the students, from one hour to 15 minutes 75 .
EMPLOYMENT HISTORY
SR. TECHNICAL WRITER/ILLUSTRATOR
INDEPENDENT SOLUTIONS, PACIFICA, CA
1996-2001
DOCUMENTATION SPECIALIST
ON CONTRACT TO MCCLELLAN AFB, TECHNICAL DOCUMENTATION SECTION
ALLSTAR PROFESSIONAL SERVICES, OAKLAND, CA
1995-1996
SENIOR TECHNICAL WRITER

WOODSIDE GROUP, WOODSIDE, CA
1991-1995
CONTRACT TECHNICAL WRITER

WOODSIDE GROUP, WOODSIDE, CA
1991
TECHNICAL WRITER
NEW COMPUTER SERVICES, MORRO BAY, CA
1990-1991
ENGINEERING TECHNICAL WRITER

MODERN OUTSOURCING
1989-1990
CONTRACT TECHNICAL WRITER

WOODSIDE GROUP INC., WOODSIDE, CA
1989
SENIOR ENGINEER/ANALYST
BERTON ENGINEER INC., SAN JOSE, CA
1988-1989
SENIOR SYSTEMS ANALYST, TECHNICAL WRITER, CURRICULUM

DEVELOPMENT SPECIALIST
INDEPENDENT CORPORATION, LOS GATOS, CA
1978-1988
WRITING SAMPLES AND ADDITIONAL DETAILS AVAILABLE UPON REQUEST.
Up
Resume 2
JENNIFER SOMMERS
Objective
To obtain a position where I can contribute my skills as an experienced
professional, resulting in a mutually beneficial growth relationship between
my employer, my team and myself.
Profile
Technical Writer/Training Developer who successfully established and

continues to maintain an independent contracting position for 6 plus years;
strong business and technical skills, exceptional organizational and project
management ability, fast in learning new technology, amiable and works
well in team and independent environments.
Professional Experience
Software User Release Notes

Produce quarterly and distribute on-line to all company employees
nationwide and clients including Sprint, Ameritech and Yellow Book.
Course Development
Designed and developed:
a one week comprehensive course for the Graphics Receiving Team
a four week comprehensive course for the Graphics Composing Team
Course work developed applying the principles of Instructional Design.

Design process including task analysis and interviewing subject matter
experts.
Development process including instructor and student guides, slide shows
and exercises.
Documentation
Developed a variety of documents including:
Job Aids for Microsoft Outlook
Graphical Recreations
Training Bulletins
Training Materials overheads, games etc.
Manage and Update over five different courses instructor and student
guides
Edit and prepare documentation for print
Provide review and feedback of team member s materials
Intranet
Developed Intranet site for the Technical Training team

Maintain and Update site
Work History
N.T.KEATON - Largest Independent Marketer of Yellow Pages Advertising

09/1995-Present
Technical Writer/Training Developer
Develop, modify and maintain various types of documentation for a

Windows based system including: procedural software user manual,
software user release notes, course development instructor and student
guides , training materials, presentations, and job aides.
Independently manage multiple ongoing projects. Created and continue to

maintain RHD training intranet site.
Richardson & Publishing Company

01/1995-09/1995
Technical Resource Editor, Electronic Publishing
Judicial case editing, conversion, collection and validation using SGML

coding.
Created Microsoft Access databases for the editing team.
Provided technical guidance for the general editors, which included creating
instruction documentation, and training new editors.
Served as a beta tester for MB s cd-rom product as well as the team leader
for a competition database committee.
Technical Support Representative

03/1994-01/1995
Provided technical support for MB s software, cd-rom and sales support

products.
This involved responding to customer s technical problems using various

troubleshooting techniques to diagnose and solve the problem over the
phone.
Support included completing follow-ups with customers and working closely
with other departments including editorial, sales, customer service and
order processing.
Also performed cd-rom and software testing, and created software

documentation for team members.
Legal Insurance Company

11/1990-11/1993
Legal Database Manager, Litigation Management Unit
Responsibilities included:
training and supervising a data entry staff of 3;
maintaining and updating a database system, which consisted of all claims

involved in litigation;
general accounting of all legal invoices on dBase IV, generating reports,

analysis of savings, reporting to senior management, assisting counsel with
preparation of reports, reviewing and summarizing file materials as well as
assigning cases to outside counsel.
Education
State University of New York, College at Cortland

Bachelor of Arts Degree, Economics May 1989
Magna Cum Laude
Phi Kappa Phi National Honor Society
State University of New York, University at Albany

Completion of First Year of Master of Business Administration Program
1994-1995
GPA 3.18
References and Writing Samples Available Upon Request
Up
Resume 3
ALEXANDER E. CARTER
37 Hillboro Lane
Elizabeth, NJ 08832
OBJECTIVE
Documentation or training development position.
CAREER SUMMARY
Senior technical writer experienced in developing end-user and

administrative information for telecommunication hardware and software.
Works directly with development and test teams to gather source material
and review documents. Quick learner who strives to increase his knowledge
in computer technologies and enjoys learning new software products and
development tools.
PROFESSIONAL EXPERIENCE
Telecom Technologies, Westfield, NJ

September, 2000-August, 2001
Contract Technical Writer
Wrote installation and administrative documentation for application

software for the Next Generation Network Voice-Over-IP product.
Documentation included both UNIX command-line and GUI interfaces.
Followed Telcordia s ISO-certified process for documentation development.
Managed documentation schedules in consultation with development and

project management.
Developed content from requirement and design documents as well as

interviews with software developers.
Worked with FrameMaker 5.5.6 and Visio software.
Transferred to the Infrastructure Solution project an integrated offering of

seven OSS products under a common GUI when first project had to cut staff.
Wrote sections of the System Administration Guide, coordinated the

inclusion of information from the contributing products, created index
entries, edited, and generated the overall book.
Contract terminated early due to budget cuts.
CHRONO Corporation, Mongomery, NJ

January, 2000-September, 2000
Senior Technical Writer
Produced user, application administration, and installation documentation

for business-to-business E-commerce software that provided Local Number
Portability LNP to Competitive Local Exchange Carriers CLECs .
Responsible for creating user documents for two versions of DSET s Local
Service Management System LSMS Java-based software.
Worked with FrameMaker 5.5.6 and Visio software.
Miranda Technologies
1996-1999
Application Software Support
Supported documentation and training group 225 people at eight locations

in New Jersey:
Provided primary support for FrameMaker and FrameMaker + SGML

applications. Researched conversion problems from earlier releases of
FrameMaker and answered questions about templates. Consulted
FrameMaker documentation, Internet resources, and Adobe technical
support to solve problems.
Wrote procedures for installing SGML template on PCs; documented

solutions to end-user problems in support database.
Installed and set up PCs including networking for Windows95, configured

browsers for Internet and mail access, setup remote dial-in access, added
local and networked printers, and installed client-server software for
network file sharing with UNIX servers.
AT & T
1978-1996
Senior Technical Writer
Developed paper documentation and training materials for

telecommunications applications.
Planned and scheduled documents for small teams of writers.
Interviewed subject-matter experts for source material, conducted reviews

of technical content with development and system test teams, tested
documentation against product.
Followed ISO-certified process for document development. Produced

documents using Information Mapping and single-source concepts.
Wrote procedures for administration, operations, maintenance, and

provisioning documents using Information Mapping concepts for several
data networking products.
Developed documentation and training products for GlobeView 2000

Asynchronous Transfer Mode ATM and Datakit Virtual Circuit Switch VCS
data networking products.
Created documentation and training materials for network management
elements of a broadband communications network in a single-source
document using FrameMaker s conditional text capability.
Learned RoboHelp software and completed a Windows help file for a

financial modeling application in 4 months.
EDUCATION
BS in Engineering Technology, Electrical Systems Option, New Jersey

Institute Of Technology.
Associate in Engineering with Highest Distinction, Pennsylvania State
University. Major in Electrical Engineering Technology.
TECHNICAL BACKGROUND
Windows 9x and NT operating systems;
development tools FrameMaker 5.5.6 and FrameMaker+SGML 5.5.6
Microsoft Office97
RoboHelp
Visio
Adobe Acrobat Distiller
CorelDraw software
Ten years experience as a user of the UNIX operating system text editors,
text formatters, and shell programming .
PROFESSIONAL DEVELOPMENT
Advanced FrameMaker
ISO 9002 Documentation Development Process
Performance and Training Needs Analysis
Instructional Design and Development Workshop
Information Mapping Structured Writing
Online Information Mapping
Authoring with FrameMaker + SGML.

Up
Resume 4
Bridget Hallmark
73 Pond Ln.
Plano, TX 75024 USA
Sr. Trainer, Courseware Developer, and Technical Writer
OBJECTIVE:
A permanent or contract position that requires a broad range of managerial
and/or technical writing, training, and training development skills such as
design and implementation of e-Learning or instructor-lead training
materials.
EXPERTISE:
Training/Courseware Development
Developed a web based training solution for TPO which enabled them to
save many thousands of dollars in training costs.
Established and managed an AT&T authorized training department with a

staff of 15 instructors in branches located in Honolulu, Los Angeles, New
York, and San Francisco.
Developed train-the-trainer courseware.
Established and headed the first authorized customer training department

for Samna Corporation in the Pacific Basin offering support to distributors,
dealers and users in Hawaii, Australia, Hong Kong and New Zealand. The
product was renamed Word Pro after being purchased by Lotus.
Assisted AT&T and Samna Corporation in developing courseware which was

marketed directly to users for self-training on Samna and Write Power
software.
Trained IBM marketing staff in Asia and Pacific Basin as resellers of a

financial services software product.
Instructed corporate users in most popular UNIX and DOS software

programs and computer operations as well as peripherals. Developed,
tested, and maintained courseware for instructors, users, resellers, and
OEM s.
Web Design/Content Development
Over 3 years experience in building web sites and writing Web Content.
Proficient in Dreamweaver, Authorware, Front Page, and CourseBuilder.
Knowledgeable in registering sites with search engines and use of meta

tags to increase visibility with search engines.
Technical Writing and Help System Development
Over 10 years experience in technical writing of hardware and software

training user manuals.
Over 6 years experience in Help system development, including training

others on RoboHelp.
Assisted AT&T with the development of a user manual which accompanied

their Write Power software for DOS as well as UNIX, working directly with
their Division Product Manager.
Assisted Samna Corporation and AT&T in developing competitive analysis

materials. The product was purchased by Lotus and is now called Lotus
Word Pro.
OTHER:
True team player with managerial experience. Work well as the lead, as part
of a team, or alone and completely unsupervised.
Able to communicate ideas in a simple and clear fashion and positively

motivate others.
Very strong work ethics.
Developed testing materials and participated in the testing of software

products.
Especially interested in cost-saving documentation management

alternatives such as Content Management/Single Sourcing storing
documentation in a repository as small components which are then reused
to build each manual, Help system, training material, etc.
Enjoy research and remaining current in the e-Learning field.
SOFTWARE SKILLS:
RoboHelp
FrontPage
HTML
Dreamweaver
Deva
CourseBuilder
Authorware
Microsoft Project
Word
PowerPoint
Visio, and all MS Office products
FrameMaker
Acrobat to develop pdf files
most graphics software such as PhotoShop, PaintShop Pro and Fireworks.
EXPERIENCE:
12/97 - Present
New Investment, Inc.
I incorporated as New Investment, Inc. and normally contract individually

through it. When the scope is larger than I can personally provide, I
sometimes work on a contract basis with other experienced professionals.
These are some of the companies I have contracted with:
TPO, Business Services

Recently completed a six month contract with TPO. Built a web based Help
system and web based e-Learning system for a software program that will
be used by all TPO employees to process expense reports and invoices. The
Intranet based training eliminated the necessity of offering expensive
instructor-led classes to all TPO employees. Also developed a Quick
Reference Guide for the program. Much of the material is single sourced re-
use of content whenever possible to reduce both production time and
development costs.
Creaton Inc.
Documentation/publications management consulting services to assist
Creaton in selecting software tools for a Content Management system and to
assist in planning their Single Sourcing initiative. Wrote a Tools
Requirements document for them which will be the basis for an RFI. Creaton
needs a Web based pull solution in the near future and will probably need a
push solution eventually. Reviewed many products from companies such as
Arbortext, SoftQuad, Ixiasoft, XyEnterprise, Author IT and Chrystal.
SmartCard Inc.
Developed Help Development, User Guides, Courseware Materials
SmartCard s encodable keycard system is used in over 40 of all hotels
world-wide. Responsibilities included designing a Help system, reseller
manuals, customer manuals, and training materials for a Windows based
Touch Screen software system. This was a challenging contract and
required advanced Help development skills as Windows Help is designed for
access by a mouse and keyboard rather than a Touch Screen. The training
material is used to train front desk as well as management personnel. The
courseware material, customer manuals, and Help systems were translated
to every major language. After completion of the first project, they
contracted me to develop Help, documentation, and courseware materials
for other SmartCard products.
10/92 - 12/97
RTS, Inc.
Help System Lead
Responsibilities included:
overseeing more than 30 Help systems some with over 2,000 topics ,
supervising, training, and supporting all permanent and contract help
authors, developing company standards for User Guides, Help systems, and
Wizards.
Additional responsibilities included evaluating new Help software tools to

maintain "cutting edge" Help systems.
Developed a method of replacing traditional User Guides with Online User

Guides derived from Help system at significant cost savings to the company.
I also managed a standards setting group comprised of the technical writers

from all divisions of the company.
10/91 10/92
Moore and Watson contract
User Guide and Training Material Development
Contract position with Moore and Watson Consulting Division.
Assigned to Ars Corporation in Shreveport, Louisiana.
Responsibilities included the design and documentation of a user manuals

and training materials for field engineers.
Also trained field engineers on use of the software.
5/89 10/91
Strategic Decisions Limited
Training Manager and Technical Writer
Responsibilities included production of user manuals and training materials

for a loan application software product for a start up company.
In addition, trained customers in instructor-led classes. Also managed the

office staff and created a company policy manual.
5/87 5/89
BSDI, Singapore Pte. Ltd.
Training /Technical Writing
Responsibilities included production of user manuals and training materials

for a loan application software product.
Trained customers in instructor-led classes. I was the entire Training and

Documentation department.
11/84 5/87
Computer Support Center International
Training and Support Manager
Original responsibilities included creating a Training Division for corporate

clients.
This included developing and implementing in house "train-the-trainer"

courses for hiring, managing, and training staff in 3 branch offices.
Additionally responsible for the development of customer training materials.
AT&T often had our organization provide training for their customers and
they would frequently request that I personally perform the actual training.
Also responsible for overseeing the development of user manuals for all
software developed by CSCI.
2/82 11/84
CompStar of Hawaii
Training Specialist/Customer Support
Responsible for training of major accounts on all software products

marketed by CompStar.
Within 3 months of hire, was promoted to Customer Support of major

accounts.
Developed demonstration data and accompanying documentation for sales
staff which increased their product knowledge and sales volume.
Assisted sales staff in Needs Analysis and demonstrations to large accounts.
MISCELLANEOUS:
Long-standing member of Lone Star Chapter of the Society of Technical

Communication STC. Active in their Online Help, Independent Contractors,
and Information Design special interest groups. Assisted as a judge for STC
Online Publications since 1997. I m also a volunteer Mentor for STC. The
Mentoring program is designed to offer career assiBelong to several
Internet lists groups including the Help, Technical Writers lists, Internet
Research lists, and User Interface Design, STC Single Sourcing list, and
AWARE Authorware list stance to students who wish to become technical
communicators.
Member of Leading Edge Women in Technology and Women in Computing .
Recently had an article that published in Technically Write, a publication

targeted at technical writers.
Attend seminars regularly Training related, Single Sourcing, Content

Management, Pubs Management, Usability, Internet Research, Help
Development, etc. to remain current with the industry. During the last 12
months I have attended 3 conferences in Chicago, New Orleans, and San
Francisco as well as a half-day STC seminar in Dallas.
EDUCATION:
BBA Hawaii Pacific College

Attend seminars regularly Training, Single Sourcing, Content Management,
Pubs Management, Usability, Internet Research, Help Development, etc. to
remain current with the industry. During the last 12 months I have attended
3 extensive conferences in Chicago, New Orleans, and San Francisco as well
as a half-day STC seminar in Dallas.
Up
Resume 5
JOHN A. PITTSFIELD, PH.D.

338 OCEAN AVENUE
LYNN, MASSACHUSETTS 01901
Qualifications Summary
Technical writer and editor experienced in technical/scientific paper editing,
documentation and user manual development, systems and procedures
analysis.
Project Experience
Wrote, edited, and produced user and system documentation. Performed

online editorial and production work on scientific and technical research
articles. Received Society for Technical Communications Award of Merit,
1993.
Wrote system descriptions and corporate procedures, based on analyses of

system and user requirements.
Interviewing, writing, editing and HTML development of internal online

corporate newsletters.
Systems
User s knowledge of PC graphical environments and editors, including

Microsoft Office, WordPerfect, Visio, Adobe Acrobat/Distiller, Dreamweaver
light , PageMill, Homesite, and FrameMaker.
Working knowledge of hard-coded HTML markup and web page design using
standard character-based text editors including vi and emacs.
Working knowledge of UNIX system shell and editing and publication tools,
including vi, emacs, nroff, and troff. User s knowledge of UNIX system
networking communications structures and procedures.
Able to read and interpret Cobol programs.
Platform familiarity includes all Microsoft systems from DOS through

Windows XP, OS/2, Solaris, Linux, and UNIX.
Employment History
Princeton Research Center, Princeton, M.A.

June 2002-Present
Contract Technical Editor
Written and Oral Communication, Department of English, The College of

Massachusetts, Norwood, M.A.
January-May 2002
Adjunct Professor
Merrill Lynch, Boston, M.A.

December 2000-November 30, 2001
Contracted through Software Guidance & Assistance, Hartsdale, N.Y.
Researched and wrote procedures to document mainframe legacy systems

supporting customer order processing.
Procedures include those related to disaster recovery/site restoration,

procedure preparation methodology, and automated system health checks.
ABCD.COM, Boston, M.A.

May 2000-October 2000
Technical Writer
Gathered/analyzed information for systems-level documentation and

coordinated and standardized preexisting documents.
Alpha Bank, Boston, M.A.

October 1998-May 2000
Technical Writer
Gathered/analyzed information, and wrote technical specifications and low-

level technical user documentation, especially standards documents for
Cobol programmers at the Boston and Horsham, MA sites involved in the
conversion from Cobol Resource to MicroFocus Cobol.
Documented use of file conversion utilities to convert proprietary db trader

data into Excel format.
Documented conversion from Cobol Resource to MicroFocus Cobol, including

a step-by-step Developer s Guide and a guide to using the Conversion
Utility.
Tools included Microsoft Office, Dreamweaver, Adobe Acrobat.
Morgan Stanley, Boston, M.A.

March 1995-October 1998
Technical Writer/Editor
Wrote and edited user and system documentation and requirements for all
areas of the Firm s trading and backoffice functions using online tools
including Microsoft Office, FrameMaker, Visio, and HTML markup.
Projects included:
runtime environment descriptions for our proprietary data filter;
quickstart cards with the Training Department ;
printshop production procedures;

application-specific help guides for traders using historical volatility
programs;
guides for external clients accessing commercial aspects of MS s TAPS

system;
help overviews for traders using the FID market risk exposure program
FRISK ;
and a user s guide to the MS Tax Database.
Gathered data for and wrote the Installation and Administrators guides for
Firmwide migration from Windows 3.11 to NT 4.0.
Edited IT-Cache, the Firm s international browser-based newsletter for

personnel in the Information Technology division.
October 1994-January 1995.

Contract Technical Writer/Editor.
Wrote and revised new and preexisting Sybase and recovery software
documentation for an international banking client.
AT&T Global Information Services, Boston, M.A.

April-September 1994
Contract Technical Writer, TransAmerica Leasing, Purchase, New York.
Wrote complete user documentation for Novell NetWare-based LAN under

development for corporate-wide use. Full responsibility for documenting
installation under OS/2 server.
Stevenson Research Center, Chelsea, M.A.

September 1993-March 1994
Contract Technical Writer.
Wrote Tools Reference Manual and Concepts Guide for Agora client-server
project in AIX/FrameMaker environment.
Jones Technical Journal, Jones Bell Laboratories, Randolf, M.A.

February 1989-July 1993
Associate Editor.
Author negotiations;
online editing and rewriting;
consulting with graphic artists and designers;
supervising articles through the production process.

1976-89
Various employer relationships inside and outside the technology sector.
Details upon request.
Education and Training
Ph.D. English Literature , State University of New York, Binghamton, N.Y.

A.B., M.A., English , Hunter College, New York, N.Y.
Professional Development seminars, Morgan Stanley, 1995-98; Cobol

Resource and MicroFocus Cobol/NetExpress, Deutsche Bank, 1999.
References
Furnished by request.
Up
Resume 6
PAUL WESTWOOD
245 HILL DRIVE
COLORADO SPRINGS, CO 80911
PROFESSIONAL SKILLS
Strong working knowledge of word processing Framemaker and Word
Familiar with Microsoft Office Products Word, Excel, PowerPoint
Creation of both hard copy and online documentation
Comfortable in both PC and UNIX working environments
EMPLOYMENT HISTORY
August 2000 Present

Colorado Springs, CO
Independent Contractor
I m working part time with a client providing technical editing on their

college level telecommunications training textbooks.
I am also creating online audio scripts for the animated illustrations, unit
introductions, and unit summaries in these textbooks in Word.
I m also working with National Semiconductor to produce the Datasheet for

their next generation GX2 processor chip for set-top boxes.
July 1995 - June 2001

ABC Advantage, Colorado Springs, CO
Technical Writer
I created user documentation in Framemaker for computer chip

development tools.
I designed and created the first true online document in the company using
Adobe acrobat reading PDF files.
I worked very closely with engineering and participated in their regular

team meetings.
I conducted engineering review meetings to ensure document accuracy.
I obtained my document information primarily from product functional

specs, engineering interviews, and use of the products.
I worked in both a UNIX and a PC environment.
January 1993 - July 1995

Colorado Springs, CO
Independent Contractor
I did a number of consulting jobs
in the computer industry including software test of backup systems for

Hewlett-Packard,
conducting computer software and hardware instruction classes for

Resource Technology Inc.,
and computer troubleshooting and repair for Applied Computer Technology.
November 1980 - January 1993

Bell Aerospace Group; Phoenix, AZ
Software Configuration Analyst
I handled Software Configuration Management for software development

work on Cockpit Instrumentation Systems.
I tracked software development from card level to system level, along with
creating the required documentation.
I created and maintained a development tracking library to accommodate
FAA audits.
Publications Engineer
I managed a team of writers, editors, and illustrators to create multimillion-

dollar proposals to the military in response to RFPs.
These were multi-volume proposals including a technical volume what we

will provide , management volume who will manage the project , and a cost
volume how much will it all cost .
June 1979 - November 1980

Hewlett-Packard Co.; Colorado Springs, CO
Technician
Maintained production equipment for manufacturing electronic circuitry.
Technical Writer
Wrote Operating and Software manuals for Desktop Computers.
I assisted in the creation and documentation of the next generation of HPL

Hewlett-Packard Language being developed in tandem with the next
generation of Desktop Computer.
I created a user s manual for the production equipment and conducted

training classes for equipment operators.
EDUCATION
June 1991. Keller Graduate School of Management; Phoenix, AZ

Masters in Business Administration w/Information Systems major; GPA
3.4/4.0
June 1979. DeVry Institute of Technology; Phoenix, AZ

Bachelor of Science Electronic Engineering Technology; GPA 3.2/4.0
AFFILIATIONS
1995 - Present. Senior Member of the Society for Technical Communication.

I use my membership to keep up with the latest industry trends in Technical
Writing. I have served as a judge in their documentation contest.
1995 - Present. Junior Achievement. I have made presentations at local

schools to help kids to understand the way their local communities work
and to encourage them to stay in school and look to attending college.
1980 - 1993. Arizona Alliance of Businesses. I made presentations at local

schools to help kids to understand the value of higher education as both a
benefit to themselves and their communities to encourage kids to stay in
school and look to college.
Up
Resume 7
SCOTT BENTON
19 LAKE DRIVE
LANCASTER, PA 18436-4018
INFORMATION TECHNOLOGY
CONSULTANT
Instructional Design, Training, Technical Writing, Web Design, Process &
Procedure Writing, Desktop Publishing, Photography, Graphic Arts, Help
Desk & Desk Side Support, Computer and Network Repair.
SUMMARY OF QUALIFICATIONS
A dedicated, highly motivated, and responsive professional with over 20

years industry experience with a unique combination of creativity, analytical
skills, and detail orientation.
Broad based experience.
Proven presentation, communication, design, photographic, technical

support, web based, and interpersonal skills.
Quickly grasps complex concepts with the ability to convey the information
in easily understood formats.
Finds imaginative and innovative solutions to complex problems.
Well disciplined with proven ability to meet tight deadline schedules.
Can ascertain needs from wants, cost versus benefits, and can apply solid
planning and organizational skills in coordinating all aspects of each project
from beginning through completion.
A history of significant client and customer satisfaction, illustrating an

ability to understand and provide just what was needed.
PROFESSIONAL BUSINESS EXPERIENCE:
Johnson College - York, PA

2001 - 2002
Instructional Design & Delivery Consultant
Recruited as an instructor for A+ Service Technician Certification, Training

Program.
Cognizant of adult learning theories, ISD methodologies, and new media

technologies, provided instruction in computer fundamentals, installation,
construction, configuration, upgrading, networking, maintenance and
troubleshooting.
Also provided instruction on operating systems Win9x, WinNT, Win2000, OS

fundamentals, installation, and upgrading, device management, disk
management, file directory & application management, networking,
Internet access configuration, and troubleshooting.
Primary Accomplishment: Turning PC novices into computer professionals

capable of obtaining A+ certification.
Lebanon Fidelity CU - Lebanon, PA

2001
Recruited to train employees in Microsoft Word 97.
Conducted comprehensive instructor led training to People First Fidelity

employees on Microsoft Word 97.
Stampo Company - Pottstown, PA

2001
Stampo Company is a commercial bakery with eight operating companies

and more than 200 brands. With more than 8 billion in revenue, Stampo
manufactures thousands of products in processing facilities worldwide
marketing them in the more than 85 countries.
Recruited to train Stampo Employees in Microsoft Access 2nd Level.
Provided stand-up classroom instruction to Stampo employees on advanced

features of Microsoft Access including, database normalization, form design,
and web data access pages.
Free Life Insurance Company - Reading, PA

1998 - 2001
Instructional Design & Delivery Consultant, Technical Writer / Web
Designer / Advanced Technical Support
Free Life Insurance Company FreeLife has approximately 1.7 trillion of life
insurance in force, serving approximately nine million individual households
in the US. FreeLife currently provides group insurance and retirement and
savings products and services to approximately 64,000 corporations and
other institutions, including 86 of the Fortune 100 largest companies.
Recruited to provide hardware, software, and administrative support to

clients around the world concerning all hardware, software, and mainframe
issues.
Provided outstanding technical support to clients around the world

concerning hardware and software, mainframe issues, and was responsible
for new hire training, and the supervision of new consultants.
Primary Accomplishment: the development and implementation of the Free-

Entex-Web based informational help desk tool.
The Web tool is designed to integrate context help training materials into a
highly responsive core solution and technical reference.
The context sensitive help improves training while reducing its cost, and the
web tool s Call Flow Processing module reduces costly procedural errors.
Kelsey & Sons, Inc. - Norristown, PA

1996 - 1998
Instructional Design and Delivery Specialist / Advanced Technical Support
With annual revenues exceeding 5 billion, Kelsey & Sons is a printer,

communications services, and logistics company with over 34,000
employees and 55 manufacturing plants worldwide.
Recruited to assist in the implementation and support of Oracle in three

states as well as assist with the instructional design project for Oracle
Inventory, Financials, Distribution, and Manufacturing.
Member of the core team associated with the successful implementation of

Oracle.
As a System Resource involved with new client start-ups, handled

production inventory control issues for warehouse management systems in
Pennsylvania, Ohio, and Kentucky.
Created the first in house instruction manual on Oracle Customer Masters

Setup.
Assisted with the training of users on Oracle as well as proprietary

software.
Primary Accomplishment: the development and implementation of both

procedure and application for order fulfillment of all bulk pick customers,
and the training of users in those procedures and application.
ABC Studio and Lab - Lancaster, PA
1976-1996
CEO
A photographer having produced award-winning art, commercial, and

portrait photography, with a fully equipped photo studio and color-
processing lab.
In addition to a host of electronic imaging software and equipment, there is

a fully stocked makeup room and model-making sculpture studio.
Random List of Accomplishments:
Industry ads for Polygram Records - Mercury Records Division
Sculpture and Photography Exhibited - Everhart Museum, Scranton PA and

the Howard Greenberg Gallery, Woodstock, New York
Recruited by The Catskill Center for Photography, Woodstock, New York to

conduct a Master Photography Lighting Seminar.
Recruited to redesign newsletter for the Evidence Photographers

International Council
A Theatre and Communication Major: A professional stage performer since

the age of thirteen, having honed though practical experience, the ability to
capture, communicate, and entertain an audience.
A formally trained actor and public speaker.
An award winning website designer.
TECHNICAL ABILITIES
OS:
Dos 3.1 through 7, Windows 3.1, Windows for Workgroups 3.11, Windows
95, Windows NT 4.0, Windows 98, Windows ME, Windows 2000, Windows
XP Professional, Red Hat Linux.
Accounting:
Peachtree Complete Accounting, TurboTax for Business, Quick Books Pro
2000
Communications:
Connectix Video Phone, Conversa Messenger, Crosstalk Intercomm Suite, CU
See/Me, Eudora Pro 4.0, Internet Phone 5.0, Microsoft NetMeeting, NetOp
School, and NetOp Remote Control, PcAnywhere, Pretty Good Protection,
SmithMicro Hot Fax Messaging Center, Winfax Pro
Data Bases:
Borderbund Dbase 5.0, Corel Paradox, Microsoft Access, Superbase 3.0, File
Maker Pro 5.0
Desktop Publishing:
Adobe Acrobat 4.0 full version, Adobe Acrobat 5.0 full version, Adobe
FrameMaker 6.0, Adobe Page Maker 6.5, Corel Ventura 7, Quark XPress
4.04, Visio 5, Microsoft Visio 2000
Document Handling:
Delrina Form Flow, Delrina Pro Form, Formbuster Form Wizard, Omni Page
Pro 8.0, Mips TransForm Suite, Text Bridge Pro
Graphics:
Adobe Illustrator 9, Adobe Photoshop 6, Corel Draw 10, Fractal Design
Painter 5, Jetsoft Art-Scan, Macromedia Fireworks, Macromedia Freehand,
Micrografx Webtricty, Microgragx ABC Graphics Suite
Internet Web Page Authoring:

Adobe Page Mill 3.0, Hot Metal Pro 5.0, Jamba 2.0, Macromedia
Dreamweaver 4, Macromedia Flash 5, Microsoft Front Page 2000, Net Studio
2000, Macromedia Director 7 Shockwave Internet Studio, and Macromedia
Course Builder.
Internet:
Forefront WebWacker, Microsoft Internet Explorer, Mips Versa Check Web
Commerce, Netscape Communicator, Peak Net Jet, Quarterdeck
WebCompass, Zip Up The Web Pro
Multimedia:
Adaptec Easy CD Creator, Blue Ribbon Soundworks Super Jam, Gvox Guitar,
Hauppauge WinTV, MGI Video Wave, Midisoft Studio 4.0, Musicware Piano,
Microsoft WebTV
Office Suites:
Corel WordPerfect Office 2000, Lotus Smart Suite Millennium Edition,
Microsoft Office Professional 95 & 97, Microsoft Office 2000 Professional
Voice to Text / Text to Voice:

Dragon Systems, First Byte Monologue 97, Kurweil Voice Pad
Utilities:
Adaptec Go Back, Mcafee Anti-Virus, Ontrack System 3, Norton Anti Virus,
Norton Utilities, Partition- It, Power Quest Drive Copy, Power Quest
Partition Magic, Symantec System Works 2001, System Commander 2000.
EDUCATION:
Master CIW Certified Internet Webmaster Designer Certification

CIW Certified Internet Webmaster Professional Certification
CIW Certified Internet Webmaster Associate Certification
Network+ Certification
A+ Service Technician Certification
BA, Temple University School of Communications and Theatre, Philadelphia,

PA
Up
Resume 8
Donald S. Stone
1325 Hilton Road
Madison, Wisconsin 53703
Summary
Senior technical writer with 16 years of experience in manufacturing,
telecommunications, industrial automation and network monitoring.
Experienced creating both print and online documentation both procedural
and reference for software and hardware products.
Work History
October, 1999 to present

Self-employed
Print and online documentation for a systems integrator/software company.
Online documentation for a new software product.
Technical edition of translated documents for a New York-based translation

company.
Creative Technology, Inc.

April, 1999 to October, 1999
Senior Technical Writer/Instructional Designer
Projects Created online PDF training materials for diagnostic imaging

equipment;
developed templates for department use;

acted as internal resource for MS Word and Adobe Acrobat
SILVER technology, Inc.

July, 1998 to February, 1999
Senior Technical Writer/Software Developer
Projects Created user manuals, online help files and online documentation
for SILVER technology s ProVision Network Monitor and Network Report
Card application software products.
Designed HTML user interface for the Network Report Card application.
Advanced Information Services

February, 1998 to July, 1998
Consulting Technical Writer
Created user manuals, online help files and online documentation for
Geneva Software s AlertPage Enterprise and Network Report Card
application software products.
Lake Resource Group

January, 1998 to February, 1998
Technical Writer
Created and coordinated documentation of the PMUSA Year 2000 project

plan.
Sybecco
April, 1997 to October, 1997
Technical Writer/Editor
Created and coordinated application support documentation for 40 Solaris

telecom applications for startup long distance service company;
edited procedures documentation created by two procedures analysts;
designed and supervised development of Lotus Notes database for

application support event log and management report creation.
Systems and Computer Digital Technology SCDT

January, 1997 to March, 1997
Technical Writer
Created and documented change-management procedures for IBM

RS6000/AIX/Tuxedo/Oracle system;
worked on application documentation for Remedy multi-platform customer

service application.
Thomas Software, Inc.
March, 1994 to August, 1996
Senior Technical Communicator
Created new user s manuals and on-line documentation for Thomas

Software, Inc. Windows, Windows NT and Windows 95 products;
performed all tasks necessary to create camera-ready copy for

documentation: research, writing including word processing , revisions,
creating technical drawings, creating screen captures.
Also created technical data sheets and catalog text for Communications
Business Unit products.
Chicago Strategic Systems

October, 1985 to April, 1993
Technical Writer
Created new manual sections and on-line help files for options or material
not previously covered;
updated laser trim system manual sections to current model specifications;
performed all tasks necessary to create camera-ready copy for hardware

and software: research, writing including word processing , revisions,
taking photographs, creating technical drawings, keyline, pasteup, sizing
and ordering halftones;
operating video tape recorder and camera;
creating presentation graphics for management, and sales functions;
some creation of artwork for engineering department.
Education
Associate of Applied Science - Technical Communications, Gateway

Technical College, Kenosha, Wisconsin - May, 1992
Associate of Applied Science - Electromechanical Technology, Gateway

Technical College, Kenosha, Wisconsin - May, 1985
Additional Coursework, Completed one year toward an Associate of

Applied Science - Accounting Degree, Gateway Technical College,
Kenosha, Wisconsin: 1974-1975
Memberships
Society for Technical Communications

Software used
Desktop Publishing/Word Processing Adobe Acrobat, Adobe Framemaker,

Lotus WordPro formerly AmiPro , Microsoft Word for Windows, Quark
Express, Pagemaker, Ventura Database Publisher, Ventura Publisher,
WordPerfect
Web/Online Help and Documentation Authoring
Adobe Acrobat, ForeHelp, Lotus Notes, Microsoft HDK, Microsoft Help

Compiler, Microsoft FrontPage 97; Microsoft FrontPage 98, Netscape
Communicator
Software development
DemoShield, Microsoft Visual Basic 5.0
Graphics
Adobe Illustrator, Adobe Photoshop, Corel Draw, Freehand, Lotus Freelance

Graphics, Lotus ScreenCam, Micrografx ABC FlowCharter, Micrografx
Designer, Microsoft Flash, Microsoft Imager, Microsoft Windows Paint,
Microsoft Windows Paintbrush, Paintshop Pro, Visio
Industrial Automation/ Network Monitoring Chicago Laser Systems Graphical

Trim Environment GTE
Thomas Software:
A.I. Series, RSLinx, RSLogix 500, RSServer Series, WINtelligent LINX,

WINtelligent LOGIC 5, WINtelligent TREND, WINtelligent VIEW
Geneva Software/SILVER technology, inc. AlertPage Enterprise,
Network Report Card, ProVision Network Monitor
Internet
Free Agent, Microsoft Internet Explorer, Microsoft Internet Mail and News,
Netscape Communicator, News Express, Anawave Gravity
Database/Spreadsheet/Utility
Dbase III, Dbase IV, Lotus 1-2-3, Lotus Approach, Microsoft Access,
Microsoft Excel, Microsoft Exchange, Microsoft Project, PVCS Tracker, Xtree
Gold, Ztree
Operating Systems
Apple Macintosh System 7, Microsoft MS-DOS, Microsoft Windows, Microsoft
Windows 95, Microsoft Windows for Workgroups, Microsoft Windows NT
Workstation
Up
Resume 9
Kora Anderson
24 Victoria Street
Shelton, WA 98584
EXPERIENCE:
Twenty years work experience as a Technical Writer, Technical Editor, and
Data Technician.
KEYWORD SUMMARY
Technical Manual Development
Illustrated Parts Breakdowns
Technical Editing
Strong Communication Skills
Software Testing
On-line Help Documentation
Training
Project Leader
Technical Support
Support Analyst
Database Support
Data Research
HARDWARE USED
IBM PC
SUN
VAX3100 & Microcomputer
DEC2065 mainframe
HP3000
UNIVAC 1100
OPERATING SYSTEMS and SOFTWARE USED
Windows 95/98/2000
MS DOS
AutoCAD V12.0
HTML
SGML
Excel
HNorton File FindiJaak Pro
Cute FTP
MS Telnet
Digital All-In-1 & EDT
COBOL
BASIC
ACCENT-R
DESKTOP PUBLISHING
Microsoft Word
WordPerfect
HTML
SGML
Adept Editor
familiar with Interleaf
FrameMaker
Robo HelpPageMaker
HTML Workshop
EMPLOYMENT HISTORY
AMADEUS Information Sciences, Inc., Olympia, WA

January 2000 - December 31, 2001
Technical Writer
Contracted to Matsushita Avionics Systems Corporation MASC for twenty-

three months as a technical writer/editor. Used ATA 100 specifications and
AECMA Simplified English guidelines.
Write and develop In-Flight Entertainment Systems IFES Aircraft

Maintenance Manuals AMMs for installations on Boeing and Airbus aircraft
and revisions.
Also edited AMMs for clarity, and accuracy. Used Microsoft Word and
company AMM style guide requirements.
Technical Editor for the IFES Service Bulletin SB section for six writers. This
entailed editing SBs for proper grammar, consistency, clarity, and accuracy,
as well as for adherence to company SB style guide.
Used engineering drawings, schematics, wiring diagrams, Engineering

Change Notices ECNs , acceptance test procedures, and software simulators
SnagIt to test software.
Interfaced with writers, engineers, shop personnel, and Boeing contacts.
Received a recognition award for expediting the Service Bulletin editing

process in support of a retrofit at Boeing and overseas at the same time.
With the efforts of the engineer, writer and myself we were able to release
the SB in three days.
NewSoft COMPANY, Everett, WA

April 1994 - Nov. 1999
Logistics Technician ;
Provided support in the development and preparation of F-14 logistics data
and services to the Naval Aviation Depot in Norfolk, Virginia and
Jacksonville, Florida.
I assisted the Senior Technical Writer in the development, preparation, and

desktop publishing of Intermediate Maintenance Technical Manuals, and
Test Program Instructions TPI, in an electronic Automated Technical
Information ATI interactive format.
Developed Illustrated Parts Breakdowns IPBs .
Using AutoCAD V12.0, created or modified test diagrams, modified

engineering drawings to incorporate into technical manuals using desktop
publication software.
Downloaded data using multiple computer platforms PC, SUN, VAX to create
graphic presentations for an optical disk.
Met deadlines for preliminary and final QA review.
Edited Navy technical manuals, General Acceptance Test Procedures,

Configuration Management Plan, Monthly Status Report, and other technical
publications.
Converted Navy Technical Manuals into an Interactive Electronic Tech

Manual IETM format using Adept Editor SGML tagging. Used WordPerfect,
Microsoft Word, Interleaf, and PageMaker.
NKLM CORP., Bremerton, WA

March 1981 - Feb. 1994
Secretary ;
Provided technical support by researching, analyzing, and resolving

software/hardware problems and source errors regarding operation of
production programs, e-mail, desktop publishing, and batch control
programs on the DEC2065 mainframe and VAX microcomputer.
Trained new customers in the use of production programs, including

ordering documentation necessary for training sessions and scheduling of
personnel.
Evaluated and tested new or modified software programs, verified that

programs functioned according to customer requirements. Recommended
improvements/corrections to programmers.
Provided information for budgeting, task scheduling, and deadline reviews.
Created and edited on-line help documentation for system programs.
Tested software when converting from a UNIVAC main frame to a DEC main
frame.
Tested software when converting from COBOL to AccentR programming
languages.
Trained users in the operation of production programs. Identified and

ordered the documentation manuals needed for customers.
Coordinated, trained and scheduled work assignments of 2 terminal

operators.
Conducted technical evaluations and assignments of Failure Class and Cause

Codes to defective MK48 Torpedo and MK30 Target assemblies, mechanical,
electrical components, and associated test equipment.
Interpreted, analyzed, and restructured technical data; and identified test

procedures used. Made judgements based on data reported.
Performed daily technical review of the Heavyweight Torpedo Technical

Data System HTTDS production reports.
ACCOMPLISHMENTS:
Recommended for assisting the Government in researching and identifying

"Not For Fleet Use" hardware in the MK48/ADCAP Torpedo program.
One of three selected to provide support to the Trident Data Extraction Tape
System data transfer task at Naval Submarine Base Bangor, WA; to
download tapes and provide product tapes and data printouts.
EDUCATION AND TRAINING
University of Washington, Extension ; Bellevue, WA;

Technical Writing Course: Scientific and Technical Editing,
The Computer in Technical Communications, Production Editing, Computer
Documentation
Tidewater Community College , Chesapeake, VA;

Business Administration. Completed 36 credit hours: In addition HTML
Webpage Design.
NewSoft Training: Oracle database
Olympic College, Bremerton, Washington;

Computer technology classes job related . Completed 28 credit hours: Data
Processing Concepts, COBOL, BASIC, math, Lotus 1-2-3, Microcomputers,
Dbase
High School : Graduate of Rancho High School, Las Vegas, Nevada
References upon request.

Up
Resume 10
Martha Shanon
267 Oakland Street
San Lorenzo, CA 94577
PROFESSIONAL OVERVIEW
I have a Master s Degree in Communications with 14 years technical writing
experience to end users, system administrators, and developers.
Technical documentation writing: FrameMaker, MS Office, WebWorks,

RoboHelp, HTML DreamWeaver and FireWorks , PDF, and JavaHelp
Completed 5-day Sun System Administration I, XML and XSLT, and 3-day
class Documenting Java API courses
I can write to end users, developers, and system administrators
Recent projects include documenting NAS servers, and CONCORD SAN and
Volume/File Replication products, and Java APIs
EXPERIENCE: CONTRACT see FULLTIME for additional jobs
Spectrum
2/2002 - 7/2002
Wrote the first and second system administration guide for a multiplatform
Linux network appliance storage server.
This project required an understanding of networking protocols, backup,

and security for Windows and Linux servers.
Also wrote a Technical Publications Style Guide.
Martinez
11/2001 1/2002
I wrote the first installation and configuration enterprise guide for this EIM
product.
Windows 2000 platform and Solaris
This job required in-depth knowledge of Windows 2000 server operating

systems and Java terminology.
DragonFly, Inc.
8/01 11/01
Documented Java APIs for DragonFly utilities
Chevron
6/01 -- 8/01
I wrote a project execution plan for Chevron s Global Information Link.
Sun Microsystems
1989 - 2000 intermittently
Sun Labs: As project lead, rewrote a guide on complex Java interface issues
originally written by interface designers
Sun Professional Services: Helped develop and write content for new Sun
Professional Services global Web site and rewrote and updated worldwide
methodology guide for SunPS consultants
Sun Sales: Managed team of outside vendors to provide all speaker and
conference attendee materials for Sun Enterprise Conference. Produced
presentations user binders, and invitation for two-track seminar
Sun Sales: Wrote and produced first four versions of Sun Server Solutions
Guide, a worldwide server sales guide
Wrote over 40 VAR profiles for distribution to server solutions sales force
Sun Manufacturing: Documented SunRai, an internal networking software

tool for downloading DB2 data to UNIX workstations
Sun Marketing: Wrote three white papers: SunRai, Why Buy a Workstation
vs. a PC, and OpenLook vs. Windows
InfoSoft Corporation
1997
Wrote first hardcopy manual for InfoSoft Personal Edition on NT in

FrameMaker.
Wrote five server installation guides for various InfoSoft server products
Oracle Corporation
1993 - 1996 intermittently
For Oracle HR Group, contributed to first HR Government User Guide on an
NT platform.
For Data and Migration Services, rewrote and edited migration guides and
white papers, developed new Technical Bulletin template, wrote digital
installation instructions for On Oracle, rewrote and formatted SAP Toolkit
Installation and User Guides, wrote SAP Toolkit marketing brochure.
Edited two Oracle Consulting manuals for distribution to a global audience
Wrote Style Guide for the Oracle Education Division
Edited educational catalogs and course schedules for Oracle Education

division
Startec
1996
Wrote technical reviewers guide for Visual Cafe Pro, a program for
developing Java applications.
This product runs on Word NT.
Charles River
1995-1996
Researched, wrote, and edited online help for five new internal financial
applications for Schwab employees from inception including Siebel
Software.
Newton Software
1995
Wrote architectural overview and database planning for Essbase Release 4.0
Administrator s Guide
Arlington Semiconductors
1994-1995
Researched, scripted, and created seven presentation modules on wireless

communications to train new distributors and sales representatives using
PowerPoint.
Global Consulting Consortium

1994
Wrote and published an executive training workbook on reengineering for

Sun international seminar using Word and PowerPoint
Created multiple executive training presentations in PowerPoint

Integrated Technology
1994
Acting Marcom Manager, managed group of 4, handled newsletter,

collateral, and ad functions
Created and scripted executive rightsizing presentation for Pyramid s

president
Managed the development of a new presentation format to work in five

media
Scripted and developed graphics for Pyramid s corporate overview
EXPERIENCE: FULLTIME
CONCORD Software
6/2000 6/2001
Product cancelled, massive lay off
Senior Technical Writer for CONCORD File Replicator and CONCORD
Management Storage
Administrator for Volume Replicator.
I wrote Administration Guides, Release Notes, and Installation Guides.
Both products ran on UNIX and NT and required extensive knowledge of

networking and server terminology on both platforms.
Wrote online Java Help for VMSA-VVR using WebWorks
Designed first internal web page for the VFR Group using DreamWeaver
Wrote internal 2-day training for VFR using PowerPoint and FrameMaker
Wrote first VFR marketing white paper
Pittsburg Corporation
1997 -1999
As Technical Publications Manager, wrote first System Admin guide for this
vendor of performance application software
Rewrote and updated User Guide and Agents Guide, including indexing and
editing for consistency
Wrote first user guide for new Java application
Strategic Communications
1990 - 1992
Technical Publications Manager for this innovator of FDDI/CDDI adapters,
concentrators, and software
Managed two full-time writers and staff of outside vendors and consultants
to create the company s first three-volume set of documentation
Crystal Parametrics
1986 1988
Public Relations Manager for one of the pioneers in desktop presentation

peripherals and software
Rolled out three new products, doubled clip count, created public relations
program for dealers
Achieved very high reader response rate from PR article placements
Swanson Public Relations

1985 - 1986
Assistant Account Executive for Harris Semiconductor account
EDUCATION
MS - Communications Management, Simmons College, Boston, 1985

BS - Public Health Management, U. Mass, Amherst, 1979
Bennington College, Bennington, Vermont, Studies in Fine Arts
TECHNICAL CLASSES
Documenting Java APIs 8/2001

XML and XLST 6/2001
Using DreamWeaver 11/2000
HTML in the Raw 10/2000
Introduction to PhotoShop 9/2000
Sun System Administration I Sun Microsystems 5 day course 9/2000
Copy Editing, Grammar, Proof Reading, Magazine Editing, HTML, Java for
Technical Writers 7/97
TECHNICAL SUMMARY
Hardware
Windows NT and 2000
Sun
Macintosh
Software
FrameMaker
Word
PowerPoint
Visio
Excel
PhotoShop
Paintshop Pro
Online SW
ForeHelp Premier 2001
RoboHelp
WebWorks Publisher
DreamWeaver
FrontPage
Up
Resume 11
Steven M. Hewlett
743 Western Springs Drive
Woodridge, IL 60540
QUALIFICATIONS
Outstanding trainer...patient, effective, and highly compatible with a wide
range of personalities
Excellent interpersonal and communication skills...versed and skilled in

team dynamics
Extremely well organized and able to meet deadlines...adaptive to various
organizational designs
Able to work independently, as part of a diverse team, or in leadership

positions...situational style
RELEVANT EXPERIENCE
Training/Communication
Four years experience as a performance/knowledge-based classroom

instructor for college-level curriculum
Over 8 years experience developing computer-based and written

courseware and job training programs
Includes student texts, training aids, handouts and correspondence material
Led development teams in conducting duty and job analyses, technical

references, and needs assessments
Determined specific training materials needed for various job functions
Meticulous administrator; validated and maintained 2,800 pages of source

material and technical references
Compliant oriented--products scrutinized during six independent

validations...rated outstanding
Computer Skills
Installed software, hubs, mainframe, and networks for workstations used

for training management
Highly proficient in MS Office Suite, Windows 95/98/2000, and the

Microsoft Internet and Exchange
Proficient in Windows NT/XP, MS FrontPage HTML composition, and

common off-shelf programs
Management
Training management--coached, instructed, and supervised 125 students

per year through technical training
Provided training and leadership for a diverse 13 person, 24-hour office as

the personnel manager
Developed work policies and written procedures to protect over 1.3 billion
dollars worth of resources
Evaluated and validated training requirements and ensured the effective use
of personnel
EMPLOYMENT HISTORY
Educational Instructor for Aaron Software Products, Arlington, PA
Shift Trainer, SpheraLink, Buthler, PA
Demonstration Specialist, Lawson Corporation, Pittsburgh, PA
Superintendent, Clinton Air Force Base AFB , San Antonio, TX
Regional Training Director, CenterPort Technologies, Naperville, IL
Technical Writer/Manager, Kramer AFB, Randolf, IL
Technical Training Instructor, Chanter AFB, Addison, IL
EDUCATION
Bachelor of Arts, Board of Governors, Eastern Illinois University, Charleston,

Illinois
Associate in Applied Science, Instructional Technology, Community College
of the Air Force
TRAINING
Instructor training - 538 hours

Computer training - 72 hours
Leadership and management - 469 hours
Technical writer - 213 hours
Up
Resume 12
Ella Kirkland
263 Lake Road
Palo Alto, CA
Experience
Nite Consulting, Inc.
February 2002 to present
Contract
Documenting plans for a university portal.
Design Specification, Test Plan and on-line User Manual.
Effective Dynamics, Inc.

February 2001 to February 2002
Permanent
Creating User s Guides, Operation Manuals, Service Manuals, Parts Catalogs.
Creating .pdfs for online manuals.
Tools include: PhotoShop, FrameMaker, FreeHand 9, Word, Sony digital

camera.
Encryption Style, Inc.

July 2000 to December 2000
Contract
Statement of Work, Co-branding Overview, design and implementation for

client contracts
serving on the Project Management Team for an encryption Internet

company.
StayFree.com
May 2000 to July 2000
Contract
Writing Operations Manual for Cisco Catalyst 5509, VLANs, load balancers &
SQL servers for web server system that tracks visitor preferences for
business to business e-commerce site.
Advanced Corporation
November 1999-May 2000
Contract
AS-400 documentation, quick start guides.
Paramount Pictures
July 1999 - November 1999
Contract
Writing, producing, creating graphics & layout design for two user &
reference manuals for Paramount Pictures Finance Department.
MS Access visual basic and CICS IBM 3270 mainframe finance application
software documentation and testing.
Training with The Beta Group

January 1999 - June 1999
Education Programming training for Control Language and RPG 3 for the
design of interactive user screens & other applications for the AS/400.
Extensive hands-on instructor-led training with lab work in a

comprehensive set of classes to build a strong foundation in AS/400
architecture and programming.
AS/400 operations including back-ups, security levels and journaling.
Computer training for corporate professionals.
California Business Solutions

January 1995 - January 1999
Permanent
Technical writer & database customer service support person. Wrote on-line
user guides for e-mail and other Internet services using Wrote procedure
guide for sales support database.
Developed database in MS Access for creating and tracking sales orders

with easy access for the teams that needed accurate information - sales,
shipping and customer service.
Developed an electronic system for damaged product exchange to recoup

money from our suppliers.
Various independent writing contracts

February 1991 - January 1995
Wrote proposals, OSHA maunuals, insurance proposals etc.
Writing samples for interview.
NGC Corporation
January 1981 - February 1991
Permanent Lead technical writer with teaching responsibilities for the
writers team.
Wrote reference and user manuals for small and mid-range laser printers
for systems operators.
Worked on engineering teams writing from specs, submitting the manuals

for beta testing with printers.
Reorganized and rewrote references manuals with more substantial
information and easier access.
Won Excellence Award from NGC in 1988 with large cash award and bonus
trip to Washington D.C.
United Investments, Inc.

January 1977 - January 1981
Technical writer & FORTRAN programmer - tools included FORTRAN, UNIX

and the DEC editor.
Wrote FORTRAN routines to create reports and to streamline user access to

hardware.
Documented custom software for Cray, DEC, CDC operating systems.
Developed operations & procedures manuals for clientsA custom

applications software.
Skills
Technical writer, business writer, & writer for client/server systems.
Minor experiencep programming for IBM AS/400 using RPG 3, Query, CL

and operations.
Experience with databases such as Baan,in MS Access, PICK, Domino and

Hedberg.
FrameMaker, Photoshop, FreeHand 9, MS Word, MS PowerPoint, MS Excel,

Paint, digital camera work for photos in my documents and Paper Port.
IBM experience with mid-range AS/400s and mainframes with CICS and
SAR.
B.A. Liberal Arts, 3.5 GPA.
Special talent for working with subject matter experts, & testing
applications.
I have my own template for Word and FrameMaker and I can create
sophicated graphics.
Very quick learner for documenting proprietary software.
Up
Resume 13
ALEX T. WEBBER
22 Crystal Street
Paia, HI 96779
OBJECTIVE
Technical Editor/Writer Content Manager Web Producer
Window & Mac Platforms
WORK EXPERIENCE
Bright Tomorrow - Makawao, HI

2001-Present
Technical Consultant
Design, create, and produce presentation materials, including displays,

maps, newsletters, online content, for policymakers and public education
employing Microsoft Office applications, as well as GIS Arcview,
QuarkXPress, Photo Shop and more.
Webmaster for Maui Tomorrow Website, updating content daily, using

Dreamweaver and FrontPage.
Volunteer Webmaster for other non-profit organizations.
Research and translate technical hydrology data from public/private

archives to create easy-to-understand publications and presentation
materials for the general public.
Design, create, manage, and maintain full-feature Web sites utilizing Web
authoring and imaging tools, HTML, CGI, Java, JavaScript, Perl database,
and e-commerce technologies.
www.planetnow.com, Leucadia, CA; Paia, HI

1996-Present
Web Producer: Independent Contractor
HotSprings, Inc. - Honolulu, HI

2000-2001
Director, Content Management
Create user interface taxonomy and logic for education-oriented Honolulu

dot-com startup.
Manage all marketing and corporate documents, as well as all Web content.
Creation and maintenance of the corporate style guide, creation of feature

requirement and specification documents for implementation by the
development department.
DigitalObjects, Inc. - Springfield, CA

1999-2001
Technical Writer / Web Production Editor
Manage all marketing, corporate, and Web editorial content for a Silicon
Valley post-startup software company, including the monthly Fusion News
newsletter.
This position also requires effective interface with Marketing

Communications and Manufacturing departments, utilizing cross-platform
file formats for print production, and providing text compatibility with HTML
editors and dynamic content delivery systems for Web page production.
Developmental Editing: Take raw drafts written or oral from content experts
and develop publication-quality, non-technical content for small-business
audience.
Copyediting and Proofreading: Review drafts of product documentation,

training materials, and Web content for standard style and consistency
without changing technical accuracy.
Editorial Project Management: Work with writers, editors, and reviewers to

deliver content to manufacturing or production.
Track deliverables, schedules, and resource requirements.
Facilitate movement of electronic resources content files, builds, backups

between team members across Windows, Mac, and Internet platforms.
Writer/Content Provider: Additionally, author corporate, marketing, and

technical content for user guides, Help, and online publications as
necessary, including brochures, display ads, white papers, technical articles,
email blasts, and corporate identity materials.
The Modern Chronicle - Arlington, VA

1996
Magazine Electronic Conversion Director
Responsible for planning and implementing the conversion of this weekly,

2-color magazine from mechanical paste-up to electronic production
procedures on-site for 12 weeks.
Installed Macintosh Ethernet network, 12 Macintosh workstations,

hardware, software, and telecommunications required for interface of
internal editorial, advertising, and production departments, as well as
external correspondents, contributors, and vendor and printer.
Trained 20 staff in the use of Macintosh hardware/software QuarkXPress,

PhotoShop, Illustrator, MSWord, etc. , while maintaining weekly publication
schedule using parallel processing.
Established electronic editorial procedures including e-mail of

correspondents dispatches, elimination of re-typesetting copy, and online
acquisition of events data.
Created digital templates based on mechanical designs for all sections of the
magazine and trained the production staff ranging in age from 19 to 66 to
implement and utilize electronic page production.
Strategic Digital Media - San Bernardino, CA

1997-1999
Production Manager / Managing Editor
Implemented Web site creation/production to HTML, PDF, and CGI using

various imaging and Web authoring applications.
Managing Editor/Production Editor of the online publication DesertUSA

Magazine .
In addition to traditional editorial and production responsibilities, I

copyedited, wrote, and photographed, as well as supervised editorial,
technical, scientific, and production staff.
Edited "The Digital Desert," an online monthly newsletter.
Maintained Ethernet, ISDN communications, ISP connection; installed and

maintained PC and Macintosh hardware and software; maintained
imagesetter and film processor.
Responsible for management of Web and digital prepress production

including scheduling, organization, staff assignments, 4-color film output,
and customer interface.
Supervised programmers, Web and digital prepress production personnel.
ABC Graphics - Palo Alto, CA

1995-1997
Project Manager
Responsible for coordinating and managing the production of technical

books and textbooks from manuscript through 4-color, digitally imposed
film.
Directed the schedule and activities of in-house production departments:
design, composition, proofreading, color scanning, electronic illustration,
image setter film output.
Supervised coordinators, expediters, production, and prepress personnel

including, hiring, firing, and reviews.
Acted as interface between publishers and internal production departments

requiring creation and maintenance of schedules, submission of bids and
quotes, communication and resolution of technical, billing, and quality
issues.
Fisherman Magazine - Carlsbad, CA

1989-1993
Managing Editor
Responsible for overall editorial management of this monthly, 4-color

magazine, including story concepts and assignments, folio size, imposition,
color use, and quality control.
Responsible for day-to-day business management coordinating the

activities of in-house office and editorial staff, as well as designers,
contributing writers and artists, as well as all vendors associated with
creation, production, and distribution.
Created budgets and supervised bookkeeping, advertising, and circulation.
Converted the mechanical production procedures used for 27 years at this

magazine to DOS- and Windows-based Ventura Publisher editorial
department and Macintosh PageMaker and QuarkXPress advertising
department , initiating electronic page production.
Acquired, assembled, installed, and maintained the requisite hardware and

software for office bookkeeping and database maintenance, editorial
electronic page composition, and color prepress.
Installed production department Macintosh network.
Performed standard editing, writing, and production tasks including photo

selection, sizing and cropping, page design and layout, copyediting,
mechanical and electronic paste-up, creation of digital files for 4-color
output to film.
EDUCATION EXPERIENCE
UH, West Oahu - Pearl City, HI: Distance Learning Social Studies BA
program
Palomar College - San Marcos, CA: Anthropology, Graphic Communications,
Botany, Statistics studies; Certification in Lab and Field Archeology, Geology
UCSD - La Jolla, CA: Human Interface Design studies

Carleton College - Northfield, MN: Liberal Arts studies
St. Olaf College - Northfield, MN: NSF grant for chemistry study
Up
Resume 14
Barbara Armstrong
42 Ocean Drive
San Francisco, CA 94103
OBJECTIVE
Experienced computer professional with extensive practice in business
process analysis and design, technical documentation and training, and
proficient with current web tools and technologies, is seeking challenging
positions to maximize skills and interests:
Participating in all phases of the software development life cycle, especially

working with clients and technical groups to devise release process models
and project plans, and write functional design and business requirements
documents.
Managing and participating in documentation projects, especially authoring,

reviewing, editing, and producing technical or end user content, online help,
reference guides, implementation and operations documents, collateral
marketing and strategy brochures, release notes, data sheets, and product
overviews and training tutorials and curricula.
Professional Experience:
TechnoSoft, Inc.
June, 1999 - present
Sr. Technical Writer
Create, edit, and maintain technical implementation and training

documentation for Financial, HRMS and PSA software applications.
Create, edit, and maintain procedural user and application documentation.
Write, edit, produce, and maintain on-line documentation.

Create, edit, and maintain installation documentation for test cycle audits
per software development and QA build calendar.
Collaborate with instructional designers to design, develop, and deliver end-

user training curriculum and class materials for training module
presentation.
Develop documentation project plans, documentation impact analyses and

documentation scope.
Collaborate with programmers and other subject matter experts to collect

and interpret input from strategy, marketing, IT or other departments
ensuring accuracy and completeness of technical documentation.
Research and evaluate documentation tools and methods; document and

improve documentation processes.
Provide presentations and training to department and intra-company group

personnel. Train and mentor junior level writers and provide informational
assistance on an ongoing basis.
Benton Book Stores

1997 - 1999
Operations Analyst
Analyze and evaluate functional retail and restaurant/cafe operations and

researching, recommending, and implementing alternative systems,
software, hardware or business process solutions for cost efficiencies.
Create, develop and edit requirements documents for software and

hardware configuration and implementation.
Create and develop training needs assessment and develop and deliver
train-the-trainer modules.
Final project assignment was to analyze costs and inefficiencies with mail
order operations, which resulted in streamlined processes that effectively
reduced personnel requirements by 1.3 FTE, enhanced software programs
and integrations, and increased customer service by reducing processing
time, netting an overall 45000/year reduction in costs in the first full year
after transition.
Benton Book Stores

1996 - 1997
Project/General Manager
Managed bookstore/cafe startup project from renovation/construction to

limited opening, through expansion and full retail operations over three and
a half years.
Collaborated with principals to plan and develop the design and
configuration of the physical store and cafes, working with architects,
contractors, equipment and systems vendors, marketing consultants and
property development group to convert historic warehouse space to a
35000sf retail outlet with adjoining residential lofts.
Responsible for all personnel management and training of bookstore and caf
staff, for ensuring quality customer services and for overseeing the day-to-
day bookstore and cafe business operations.
Supervised staff of 70, including: buyers, assistant managers, floor

managers, caf operations staff, computer operators and other back office
functional staff.
Responsible for the oversight of and analysis and reporting of the budgetary
and financial aspects of the retail cost/revenue center, managing inventory
levels, and working directly with vendors and consultants to purchase and
promote inventory and services.
WoodStock, Inc.
1995 - 1996
Implementation & Documentation Specialist
Provide onsite implementation consulting, installation and training services

from system configuration through testing, training and production.
Provide onsite and remote network management, administration,

installation, repair, and maintenance services to clients.
Create, develop and maintain user continuing education training modules

curriculum. Manage seminar, workshop and client user meeting tradeshow
events.

Maintain entire end user documentation set for Point-Of-Sale, database

inventory management, order management, mail order management,
receiving, and retail accounting applications.
Benton Book Stores

1993 - 1995
Information Systems Manager
Responsible for managing the organization s overall internal information

technology architecture and systems
Responsible for the day-to-day management of the organization s

information systems, including databases, operating systems, networks,
technical support, and PC and server maintenance.
Create and develop training modules and provide new-hire and continuing
education training modules to management and staff.
Supervise the IS staff, including the network administration, database

administration, PC support and tech support specialists, and programmer.
Responsible for the budgetary and financial aspects of running the IS group,
and interface with vendors and consultants to purchase hardware, software,
and services.
Skills:
Excellent oral and written communication skills and deep understanding of

programming concepts, operating systems, hardware platforms and
networks. Keen attention to detail and excellent ability to grasp the big
picture .
Tools Platforms/Databases/Languages:
Arbortext EpicEditor
Documentum
Microsoft Office
Word, Excel, PowerPoint, Outlook, PhotoEditor
Visio
Lotus Notes
Microsoft FrontPage
Microsoft Project
Microsoft Access
Macromedia Dreamweaver
Allaire Homesite
Adobe Framemaker
Adobe Acrobat
Adobe Photoshop
Techsmith SnagIt
Quark
Relational Databases
TechnoSoft
Windows/Windows NT Unix
HTML
XML
POSIX
COBOL
SQL
Education:
University of Northern Colorado

BA, Political Science
References/Work Samples:
Available on request.
A FAQ, pronounced by some as "fack" and others letter-by-letter ("eff aye

cue,") is a list of answers to frequently asked questions. FAQs originated in
the early 1980s as the means to give informed answers to the recurring
questions that are continually asked in the discussion newsgroups called
Usenet. For more information about FAQs in general, please refer to
_http://www.faqs.org/faqs/faqs/about-faqs/ by Russ Hersch. For Web
versions of all of the Usenet FAQs, please see the _http://www.faqs.org/faqs/
or another repository
(_http://www.worldwideschool.org/library/books/tech/computers/TheHackers
DictionaryofComputerJargon/chap24.html).

Tech Writing Brief

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Tech Writing Brief

Enviado por

Direitos autorais:

Formatos disponíveis

A user guide, also commonly known as a manual, is a technical communication

The usual sections of a user manual often include:

A preface, containing details of related documents and information on how to best

A guide on how to use at least the main functions of the system

A FAQ (Frequently Asked Questions)

Where to find further help and contact details

A glossary and, for larger documents, an index

Quick Reference Cards

What Is A Functional Specification?

Why write a Functional Spec?

A key benefit of writing up a Functional Spec is in streamlining the

Why should I consider FrameMaker?

Why should I consider structured FrameMaker?

XML-based publishing can substantially improve an organization’s capabilities

Why DITA? (http://dita.xml.org/why-dita)

But, why DITA?

A Content Management System (CMS) is a software system used for

A web content management system is a content management system with

Today's content management systems are elaborate software/database

Any application which manages information could technically be considered a

A Help authoring tool or HAT is a software program used by technical

Technical Writing Process

Know your audience

Exceptions to this rule exist….

What is Information Mapping?

Information Mapping is a structured approach to creating clear, concise and

Horn and his colleagues identified dozens of common documentation types,

XML stands for EXtensible Markup Language

XML was designed to carry data.

XML is not a replacement for HTML.

It is important to understand that XML was designed to store, carry, and

API Documentation Tutorial

In this tutorial, I will focus on the basics of an API function.

An API (Application Programming Interface) allows programmers to access

What comprises an API function?

Examining our example API function SetDoubleClickTime we find that the

Where does the API function reside?

When documenting an API, the following points must be covered:

Name and Purpose of the API function

Let us document our example API function:

Header file: Windows.h in user32.dll

Issues to be aware of: None

Unplanned internal job openings: There is a sudden opportunity to

1. Can you concisely state your value proposition in 30 seconds or less?

Be prepared to answer these questions:

How would you best describe yourself?

What is your major achievement: professional and personal?

Why would you like to leave your current organisation?

How do you see yourself five years down the line?

I hope to look back and see that I made a difference".

What is your career objective in the years to come?

What are your weaknesses?

How to Shape Your Personal Brand on LinkedIn

Is your resumé the key to a higher salary?

A prospective employer’s first impression of you is created entirely by your resume.

First impressions are nearly impossible to change.

Consider using the number of man-hours saved in process improvements, the

Illustrate the breadth of your experience.

There are two key ways to express breadth of experience:

Entice the reader to want to know more about you.

1. Not understanding the hiring motives of your audience

Differentiate b/w project & product

A product is an artifact that is produced, is quantifiable, and can be either an