|
|
 |
|
|
Great Technical Writing: The User-Product Life Cycle - A Documentation Tool
The User-Product Life Cycle (U-PLC) is a powerful tool for the User Document writer Use the U-PLC to generate the high-level topics for your User Document...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: Tell Your Users What To Expect
OVERVIEW
In your User Documentation, you direct your Reader to perform tasks with your product If you don't tell your Reader what to expect when performing those tasks, you will have a baffled Reader, resulting in dissatisfaction and expensive calls to technical support...
Author: Barry Millman - Category: Writing
|
| |
New Technical Writer: Have No Fear Of Writing
OVERVIEW
You're a non-writer who has just been assigned to write the User Documentation for your company's new product...
Author: Barry Millman - Category: Writing
|
| |
How Poor In-house User Documents Cost You Twice & What To Do About It
OVERVIEW
Many organizations produce in-house tools or modify commercially-available tools for their own use...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: User Document Headings Should Be Guideposts, Not Advertisements
OVERVIEW
Most heading are designed to entice us to read further Headings in User Documents should enable your Reader to decide whether or not to continue reading that section...
Author: Barry Millman - Category: Writing
|
| |
|
|
Great Technical Writing: Improve Your Readers' Access With A Visual Index
OVERVIEW
People are visual creatures They look at your product, and see, for example, a button or display...
Author: Barry Millman - Category: Writing
|
| |
Benefits Of Creating User Documents In-House
OVERVIEW
For small companies, creating their product's User Documentation in-house, provides benefits to the company, to (idle) staff, and to the product...
Author: Barry Millman - Category: Writing
|
| |
New Technical Writer: Avoiding The Interview-writing Disconnect
OVERVIEW
Lost or garbled information is a terrible waste Especially if it's the information you gathered from an interview and must now write into your User Document...
Author: Barry Millman - Category: Writing
|
| |
New Technical Writer: Don't Confuse Your Reader With Your Words
OVERVIEW
Stop confusing your Reader with the words you use Your Reader is trying his/her best to understand how your product works without having to figure out your writing...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: Improve Document Searches
OVERVIEW
Searches in User Documents (manuals, etc) often fail because the Reader uses different words for a concept than the author uses...
Author: Barry Millman - Category: Writing
|
| |
|
|
New Technical Writer: Use The Persona To Create The Most Useful Section Of Your User Document
OVERVIEW
A good User Document includes sections on how to set up, use, and care for the product However, to create a great User Document , the technical writer should use the Persona, generated in the analysis of the User/Reader, to create the topics for the most useful section of the User Document...
Author: Barry Millman - Category: Writing
|
| |
New Technical Writer: The Four Dimensions Of Your User/reader
OVERVIEW
To create an effective User Document, the writer must know who he/she is writing for This article presents four dimensions (Skills, Attitude, Knowledge and Experience) for describing the User of your product (your Documentation Reader), and how to build a Persona that turns your generic User into an almost-real person...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: How Small Companies Can Create Great User Documents
Overview
Your product needs User Documentation (manuals, instructions, etc), but your small company (20 to 100 employees) has no in-house staff to create that documentation...
Author: Barry Millman - Category: Business Management
Rating:  |
| |
Great Technical Writing: Make Your Product Fit
OVERVIEW
Most product documentation sounds like their product is the only thing in the User's life Such thinking results in User confusion and dissatisfaction...
Author: Barry Millman - Category: Writing
|
| |
New Technical Writer: First Things To Do On The Project
OVERVIEW
You, a non-writer, have just been assigned to write the documentation for a product your company produces or markets...
Author: Barry Millman - Category: Writing
|
| |
|
|
|
Great Technical Writing: Sell Your Readers On What's Important
Overview
Our humdrum, sterile headings and writing manner do little to encourage our Users to read parts of the product documentation that would be especially beneficial for them...
Author: Barry Millman - Category: Writing
Rating: |
| |
Great Technical Writing: The Two-edged Sword Of Reader Experience
Overview
When we write User Documents we rely on our Reader's/User's experience to simplify our work...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: Beware Of Your Editor/love Your Editor
Overview
Your editor should be an integral part of your writing team Do not think of him/her as a judge, but rather as a resource to help you in all phases of the writing project...
Author: Barry Millman - Category: Writing
|
| |
Great Technical Writing: Banish These Two Attitudes
Overview
Incomplete User Documents disappoint your Readers Two attitudes of many Technical Writers result in incomplete User Documents...
Author: Barry Millman - Category: Writing
Rating: |
| |
Great Technical Writing: Don't Let Your Product's Features Become Expensive Flaws
Overview
Your product's unexplained features can turn into costly flaws This article describes three real-world products with just such "features...
Author: Barry Millman - Category: Writing
Rating: |
| |
Great Technical Writing: Has Anyone Ever Used Your Product?
Product documentation gives the feeling that nobody has ever used the product Most documentation:
...
Author: Barry Millman - Category: Writing
Rating: |
| |
|
|
| |
| Result Page: | |
1 | |
|
