TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Summary on White Papers From:"Shelley Hoose" <shelley -at- a-frame -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 12 Dec 2000 14:18:34 -0800
Thanks for this great summary. It's going in my files.
----- Original Message -----
From: <rhoggan -at- lewis -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Tuesday, December 12, 2000 12:00 PM
Subject: Summary on White Papers
I was recently assigned to write some white papers for our company and had
no clue where to start. The query in the archives turned up several posts,
most being requests for information. Since I couldn't find a summary of all
that was posted, I compiled many of the posts and did some simple edits. It
seems that the topic of white papers comes up on the list at least twice a
year, so this might be helpful to those in need. If anybody has anything
else to add, or wants the word document, just let me know.
I apologize in advance for any grammatical, spelling, or organizational
errors within the following summary.
Introduction to White Papers
White papers are used both by government and business to explain a concept,
idea, or product. A white paper's purposes may include sharing of
information with technical people in the same field, providing statements
of legitimacy, and educating clients and prospective clients about products
or strategies. The paper may also explain how the product will benefit you
or your company.
Generally they are a summary of known information about a topic, and it is
very likely that the white paper is often a proposal for action, or a
conclusion with the background information providing justification.
Formal White Papers
There are two different types of formal white papers: Information Papers
and Decision Papers. They are very similar but have a slightly different
focus. Typically, they address the same audience.
Information Paper
1.0 TOPIC
This portion of the paper includes introductory information such as the
document name and the producer of the document. In white papers with
hyperlinks, this section may contain links to similar papers, sections
within the paper, and the company website.
2.0 EXECUTIVE SUMMARY
This is a brief abstract of what will be discussed in the white paper. It
explains what the reader will learn if they continue reading.
3.0 BACKGROUND
The background often explains why the document was created. Sometimes a
short company or product history is included.
4.0 INFORMATION
This section is the meat and potatoes of the document. It is structured
accordingly to accommodate the audience and the company's defined goals.
5.0 REFERENCES
If applicable, references are provided.
Decision Paper
The decision paper is designed to help the targeted audience make a
decision regarding the subject of the document. It is similar to an RFP. It
is organized into the following format.
1.0 REQUIREMENT/PURPOSE/ISSUE
Contains all the data included in the Introduction, as well as any
questions the paper attempts to resolve.
2.0 EXECUTIVE SUMMARY
This is a brief abstract of what will be discussed in the white paper. It
explains what the reader will learn if they continue reading.
3.0 BACKGROUND
The background often explains why the document was created. Sometimes a
short company or product history is included.
4.0 ASSUMPTIONS
The assumptions section contains issues and concerns regarding specific
details about the item presented in the document. It can also contain any
predefined or presupposed agreements between the audience and the
publisher. This section is not always required.
5.0 CRITERIA FOR EVALUATION OF ALTERNATIVES
The criteria used for evaluating alternatives depend on the topic of the
paper, and the solution provided to the audience. This section is not
always required.
6.0 ALTERNATIVES
This section compares the topic of your paper with other existing
solutions. Here, you can point out strengths in your item by identifying
weaknesses in competing items. This section is not always required.
7.0 RECOMMENDATIONS
Recommendations may include what strategy the targeted audience should take
concerning the items presented in the document.
Casual White Papers
Casual white papers often take the form of an essay. In business, they
often take the appearance of a technical marketing brochure.
These guidelines should be considered when creating casual white papers:
1. Length: a white paper should be concise, since it strives to globally
explain the mechanics of a given concept or item. Its primary aim is not an
end-user tutorial.
2. Standards: since a white paper is meant to be succinct, its layout
should be simple and clear. Some authors occasionally append a short
glossary at the end of their white paper.
3. Content: a white paper should present the elements inherent to a given
concept or item, and explain why it is different from similar ones that
already exist.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.