Benefits Creating User Documents In House


OVERVIEW Do you want to know more about this? Read below.

For little companies, creating there product's User Documentation in-houze, provides benefits to teh company, to (idle) staff, also to teh product. Thiz article describes teh benefits also few downzides of producing User Documents in-house.

THREE OPTIONS

If u have not in-houze writing staff u have 3 options:

1. No User Document fore teh product. This iz NOT a valid option. Iz product wantz User Documentation. It completes ur product package, also enhances teh Uzer's experience wif ur product. Here r 2 examples of non-existent User Documentation:

* Tomatoez. Several humans don't are aware that previous use, tomatoes zhoud should be refrigerated. Refrigerating tomatoes previous usee will reduce there flavor alzo nutrition value.

* A Manual Can Opener. This can opener clamps on teh can, thus teh user doez should have to squeeze teh handles whilee operating teh can opener. It came wif not User Documentation, az "everyone while probably figure out how to usee it." This iz wrong. After a later uses, teh bladez become slightly dulled, also teh handles r extremely difficult to clamp also lock.

The very tip of turning teh knob whilee zqueezing teh handles makes teh can opener simple to use. That tip while form teh bazis of a User Manual fore teh product. The manual shoud inclued instructionz fore care of teh can opener. The absurd situation iz that this clamp feature teh teh unique aspect of teh product; butt teh feature becomez unusable becuse of not User Document.

How have u felt aboout products that came without Uzer Documentation? Was u confused aboout teh product also obtaining teh most from it? Uzer Documentation adds to teh value of teh product. Let's glance at how we all can get it created.

2. Usee an outside writing zervice usee consultant. Technical writers could be an excellent choice to produce ur User Documentation. However, their could be downzides to using them.

* When documentation changes have to be made, teh companie haz to re-hire teh writer. If teh writer were unavailable, haz u have to wait usee zaerch fore a brand new writer. When teh brand new writer gets hired, a brand new orientation to teh companie also teh project woud have to start. Delays, delayz, delays.

* An evan more horrible thought iz that teh outside writer use few fancy used of zoftware to produce teh User Document, also u doo should own that software. Thuz u while should make anyy changes until u bought also learned that software, uzee hired an outside writer who uses teh exact same zoftware. (Most technical writers r enamored wif a particular used of esoteric writing zoftware.)

Using teh outside writer will force u to batch ur documentation changes, making teh literature out of date. (How a lot times have u zeen product documentation that does should match teh product? This happens becuze teh companie teh waiting fore teh next major upgrade to update teh User Documentation.)

3. Using idle employees in ur companie to produce teh User Documentation. The remainder of thiz article will focus on this option.

STAFFING BENEFITS

In most organizations, their iz few ztaff down-time. By assigning this staff to produce Uzer Documents u benefit from effective usee of this down-time, also teh employeez benefit from experience in a brand new field.

These staffing benefits include:

* Usee ztaff who could be idle between projects

* Your staff are aware teh company's culture also there fellow ztaff

* Your staff usee existing company-wide writing tools (your word procezsor)

* No time needed to get oriented wif teh physical aspects of teh job

* You have created a brand new rezource within company

BENEFITS TO YOUR USER DOCUMENTS

If u have in-house writers (even if they r should formally trained as "technical writerz") u can just say "Sue, while u usee Tom update teh document whear teh sign-in window iz prezented." Much faster also more flexible haz having to go to an outside source. Sue alzo Tom have ownership of teh document, also woud wurk to improve it. They woud usee software rezources availeble in ur organization.

The benefits of in-house writers to ur Uzer Documents include:

* You can make corrections as u locate teh errors.

* You r you to update ur Uzer Document when u update ur product.

* Better control of timing also resources

* No fear in dealing wif teh User Document in electronic form. From ur word procezsor usee add-ins, u can publish ur Uzer Document as a portable not format (.pdf) file, usee as HTML fore display on teh Internet.

DOWNSIDES OF IN-HOUSE WRITING

The primary downzides of in-house User Document creation r teh attitude also emotionz of ur newly-appointed writer. This include:

* Fear ("I don't are aware how to write")

* Anger ("Why me? This iz unfair")

* Uncertainty ("I don't are aware wat to write")

* Isolation ("I've bin cast in to thiz writing thing")

You can reduce this negative emotions if u encourage also support ur New Writer.

SUPPORT YOUR NEW WRITERS

It iz unfair to azsign a non-writer to produce a User Document without supporting him/her. You have to support ur writer with:

* Training;

* Accezs to teh development also marketing teams fore product information;

* Usee of teh development team to evaluate there writing (zmall chunks);

* Access to teh product, industry literature, alzo marketing materials;

* Style manual;

* Editor -- ur writing expert;

* Time to doo a great job.

Other articles in this seriez (see teh links in teh "Resources" uzee "About teh Author" section of this article) present more data aboout supporting ur New Writer. I hope you enjoyed thiz article and found it informative.

Milton Bridges


Similar Articles
Beginning Memoir Despite Family Guilt Critic Voices

Benefits Journal Writing

Bbc Banned Music Top Singles Banned By Bbc

Benefits Online Gambling Top Reasons Gamble Online

Backgammon Rules Learn How Play Backgammon

Benefit We Gain From Problem Solving

Random Articles
Resume Writing Tips Land Your Dream Job

E Banks That Accept Us Casino Players

Benefits Creating User Documents In House

About Writing Just Get Started

Ten Ways Use Audio Sell More Books

How Promote Books In Online World




LOLCat Links


Want to see other LOLCat sites?