USA India
Home Articles UserTV Press Releases Dictionary Books Education Careers B-Channels Resources Forums Blogs Classifieds
Saturday 11 Oct, 2008 eNewsletter Register Login
Archives
PR Archives
 
  Submit an Article Articles Home
Search Articles
Articles >> Software
The Art of the Impossible: Estimating Documentation Costs
Posted by : Pettice | Mon, Sep 17 2007 | 03:09:29
Tags : software documentation, estimating software documentation
Rating : 4/5
Comments (0) Views (5) Email Article Blogs Forums
Discuss Print Article Bookmarks
Add to More..
 

Estimating documentation costs for a project seems like it’s almost outside the realm of possibility, like finding the perfect hamburger or a jacket that fits you just right. Like clothing and food, there isn’t a “one size fits all” amount of hours you can perform for a particular project because each project and each writer are different. For example, one or more of the following situations may apply to you:

 You are a freelance or contract writer who telecommutes most of the time, and you don’t work on a regular 8-to-5 schedule.

 You work on site as a full-time employee, but you may or may not have a team of other writers working with you.

 You are working on several projects at once, each with different requirements: you’re creating print documentation for a hardware product, a PDF file and online help for a software product, and updating a product Web site with updated information and online training.

 You’re working on usability studies and testing as part of project development.

 No matter what situation you find yourself in, it’s always difficult to figure out where to start. The answer is easy: start with you.

 Do Your Homework

When your project manager asks you for estimates and deadlines, only you know how productive you are. If you’re not aware of how productive you are, remember back to past projects and put together some simple metrics to give yourself an idea of what you can do. For example, in your last project you may have been able to write and edit content on one 8½ by 11 inch page in one day. From that, you can determine how many words are on that page, and then determine how much time it will take to write so many words (or pages).

 

If you’re a freelancer or you have your own business, you also need to find out how much to charge. To provide an accurate quote, you need to do your homework. For example, look at other companies that provide similar services. You can also research salary surveys online, such as the technical communicator contractor survey produced by the Society for Technical Communication. Mailing lists and newsgroups such as the TECHWR-L mailing list for technical communicators are also valuable resources.

 The Ever Changing Product

If at all possible, learn about the changes that will be made in the product during development, and what effects those changes will bring. For example, in a software product you may have two buttons. Button A brings up 4 choices, and Button B brings up 5 choices. However, if the button functionality changes during the development process and you’re not aware of it, you or your customers could suddenly discover that your documentation for the final product is incorrect.

 Therefore, it’s hard to understate the importance of keeping in close contact with the development team if at all possible so you can update your documentation accordingly, instead of having your customers and/or stakeholders pointing out the problem.

 Document Your Documentation

As you create a checklist of everything you need, be sure to share this checklist with your project team and/or manager so everyone understands what features are supposed to be added. If there are any additions, be sure to keep a copy of your own checklist and, if necessary, distribute that checklist to the other project team members and be sure everyone understands what changes are being made not only to the project list, but also the effects those changes will have on the timeline and the project budget.

 If you’re a freelancer or you run your own business, you need to have a contract in writing that establishes all the work you will do for the company. If your client decides to add more work on your plate that’s beyond the scope of the contract, be sure the contract states that you will work on a per-hour basis at your hourly rate.

 No matter if you work on a project team or you work independently, always be sure to add markup. Markup is additional time and costs on top of your original estimate to ensure that any delays in the development process will be compensated. For example, if a key software engineer on the project team goes on vacation, you’ll need to compensate for that in terms of time and/or money.

 The Uncertainty Principle

When I talk with people who are just getting into the technical communication field, no matter if they’re getting into technical writing, online help creation, instructional design, and/or Web design, I ask them if they’re familiar with Star Trek. If they are, I tell them they need to incorporate their own Heisenberg compensator, the device that the Star Trek universe uses to compensate for the Heisenberg uncertainty principle when people beam from one place to another.

 Uncertainty is part of the job when estimating documentation costs, and some answers only come from the fountain of experience. As you continue to create estimates for clients and provide the documentation you and your team need to protect yourself and the development process, you’ll gain the confidence of the company and its stakeholders as well as peace of mind.

 About Writing Assistance, Inc.

Eric Butow is a contract technical writer for Writing Assistance (www.writingassist.com).

Writing Assistance, Inc. specializes in contract technical writing, copy writing, web content specialists and training developers and is dedicated to the proper placement of contract writers nationwide.

 
 
 
Comments (0) Views (5) Email Article Blogs Forums
Discuss Print Article Bookmarks
Add to More..
 
View all | Recent | Popular | Community Recommended | Most Viewed | Today in Article
 
 
Archives by Date
 
 
 
2008
2007
 
 
Copyright © 2001-2008 ComputerUser, Inc., All Rights Reserved
About us | Terms of use | Privacy Policy | Legal | Trademark/Copyright | Awards | Advertise | Writer guidelines | Sitemap | Contact | FAQ's | Feedback  | Link to us

Here are the topics we cover computer certification computer careers computer training computer games consulting data recovery data security digital entertainment emerging technology gadget reviews handheld computers hardware reviews home automation home networks home office how-to advice internet linux local companies local news local profiles macintosh mp3 players network security online music online security open-source small-business technology soho software reviews technology books technology dictionary vpn web site reviews wi-fi windows wireless technology tech articles tech news press releases tech dictionary education resources career solutions create your personal blog upload your videos become a writer usergroups special interest group SIG 3com cipts adobe adobe certified expert apc ncpi apple achds acpt acsa actc avaya bea 8.1 certified administrator 8.1 certified architect 8.1 certified developer 9 certified administrator bicsi rcdd checkpoint ccmse ccsa ccsa ngx ccse ccse ng plus with ai ccse ngx cisco access routing and lan switching ccda ccdp ccie ccip ccna ccnp ccnp old ccsp ccvp crmam ip communications optical proctored exams for validating knowledge sales specialist storage networking vpn and security wireless lan citrix cca 3.0 cca 4.0 cca 4.5 cca xp ccea 3.0 ccea 4.0 ccea xp ccia ciw ciw associate ciw certified instructor master ciw admin master ciw designer master ciw enterprise developer security analyst comptia a+ network+ security+ server+ computer associates ca cusa cuse cwna cwna cwsp dell eccouncil cea cep certified ethical hacker chfi e-commerce architect emc emc specialist implemenation technology foundations enterasys ese eta exam express exin exin itil extreme networks ena ens filemaker f7cd f8cd fortinet fortigate foundry cne fujitsu fujitsu guidance software ence hdi css hda hdm hdsa hitachi hitachi certified professional hp ais apc app aps ase certified systems developer csa cse master ase huawei hcne hyperion hcp ibm advanced deployment professional advanced technical expert application developer business process analyst certified administrator certified advanced system administrator certified advanced technical expert certified associate developer certified enterprise developer certified solution designer certified specialist certified systems expert database administrator db2 deployment professional enterprise developer eserver certified specialist ibm on demand business solution advisor solution designer solutions developer solutions expert storage administrator system administator iisfa cifi intel isaca cisa isc cissp sscp iseb itil ism cpm juniper jncia jncis legato lcaa lcea lotus clp lpi lpic level 1 lpic level 2 lpic level 3 macromedia mcafee mcdata csnd microsoft crm mbs mcad .net mcdba mcdst mcitp mcp mcpd mcsa longhorn mcsa 2003 mcsa 2008 mcsd .net mcse mcse 2000 security mcse 2000 to mcse 2003 upgrade mcse 2003 mcse 2003 messaging mcse 2003 security mcse 2008 mcts microsoft business solutions microsoft partner competency mile2 cnsa network appliance nac-na nac-nie naca nace nacp network general sniffer certified professional nokia nokia security administrator nortel ncde ncds ncse ncss ncts novell5 cna 5 cne 6 cna 6 cne 6.5 cne cne upgrade omg ocup oracle 10g dba 10g oca 11i 8i dba 9i dba 9i internet application developer oca ocp8 to ocp8i dba upgrade exam pmi project management professional polycom pcve redhat rhce rhct sair sas institute sas scp saas scp snia snia certified architect snia certified professional snia certified systems engineer snia storage networking certification program administrator professional associate symantec scse scsp scta scts teradata tca v2r5 tcad v2r5 tcda v2r5 tcis v2r5 tcm v2r5 tcp v2r5 tia ccnt ctp tibco tcp trusecure ticsa veritas infraguard chamber of commerce vcp vmware certified professional webex linkedin facebook myspace Professional page layout, image editing, vector illustration, and print production Website design, development, prototyping, and blogging Creation of rich interactive content Industry-standard visual effects and motion graphics Video capture, editing, and production; DVD titling; and digital audio, Adobe Photoshop CS3 extended, Adobe illustrator CS3,Adobe indesign CS3,Adobe Acrobat 8 Professional, Adobe Flash CS3 Professional, Adobe Dreamweaver CS3,Adobe Contribute CS3,Adobe Fireworks CS3,Adobe After Effects CS3 Professional, Adobe Premiere Pro CS3,Adobe Soundbooth CS3,Adobe Encore CS3,Adobe OnLocation,Adobe Bridge CS3,Adobe Version Cue CS3,Adobe Device Central CS3,Adobe Stock Photos, Intel Pentium 4 (1.4GHz processor for DV; 3.4GHz processor for HDV), Intel Centrino, Intel Xeon, (dual 2.8GHz processors for HD), or Intel Core, Duo (or compatible) processor; SSE2-enabled processor required for AMD systems Microsoft Windows XP with Service Pack 2 or Microsoft Windows Vista Home Premium, Business, Ultimate, or Enterprise (certified for 32-bit editions) 1GB of RAM for DV; 2GB of RAM for HDV and HD; more RAM recommended when running multiple components 10GB of available hard-disk space (additional free space required during installation) Dedicated 7,200 RPM hard drive for DV and HDV editing; striped disk array storage (RAID 0) for HD; SCSI disk subsystem preferred Microsoft DirectX compatible sound card (multichannel ASIO-compatible sound card recommended),1,280x1,024 monitor resolution with 32-bit color adapter Blu-ray burner required for Blu-ray Disc creation OHCI compatible IEEE 1394 port for DV and HDV capture, export to tape, and transmit to DV device QuickTime 7.1.2 software required to use QuickTime features Broadband Internet connection required for Adobe Stock Photos* and other services