Software Development Companies!

Are you missing upsells?

If you don’t offer your clients documentation services with your software products, your services are incomplete, and you are overlooking billing opportunities.

Java Programmer Requirements

• Java coding

Tom Murphy Services 2

A tech writer may be called upon to use:

• The MS Office Suite

– Word

– Excel

– Access

– Publisher

– PowerPoint

– Visio

– Publisher

• Multiple email systems

• Web Content

• Process Documentation

• WinZip

• Adobe Professional

• Photo Shop

• Document scanning hardware and software

• RoboHELP/RoboHTML Help File generators

• Screen Capturing Utilities

• Any tool purchased by a client and in use

Tom Murphy Services 3

Tech Writer Requirements

Too Expensive?

Tom Murphy Services 4

Java Programmer

Java Programmer Technical Writer

$97,208 $51,975

Java Coding Between 10 and 15 software utilities

and applications

Tech Writer

Which is the better value?

Possible Tech Writing Deliverables Development Phase • Architecture Diagrams • Business Requirements • Data Conversion Plan • Deployment Plan • Software architecture document • Functional Specifications • Detailed Specifications • Testing Plans (SIT, UAT, SaaS, etc.) • Run Book • Client-specific internal document

requirements • APIs • Calls • Network Details • Security Layer

Tom Murphy Services 5

Deployment Phase • Training documentation

– Class content – Training aids

• User guides • Quick Reference

Pamphlets or Cards • Promotional Materials • Marketing Brochures • Email notifications • Help Files/FAQs • Web Site Content

Let the Developer Do It? There are many reasons why this is not practical:

• The developer’s skills are different from the writer’s. Each does not know the other’s business

• Developers may be needed for other, different coding initiatives

• Developers may be needed for bug fixes

• The developer may not be strong in writing in English. English may not be the developer’s primary language. Those who speak well do not necessarily write well. Developers are too close to their creations, and tend to tell too much.

• Developers tend to be too technical

Tom Murphy Services 6

Applications Require Documentation

• If the client company is large, the application you are developing for them will have to pass through some form of System Development Life Cycle (waterfall, agile, etc.). Beyond that, the company will have some form of certification process or audit trail, and your software documentation may be reviewed by internal auditors or regulatory agencies. Specifications will be needed.

• If the company is small, it will also need to have specifications written so that they can farm out parts of the development effort to sub-contractors, if necessary, and to convince their customers of your attention to detail.

• Whether the company is large or small, they will likely want technical documentation in some form.

• Anticipate the documentation requirements, and build them into proposals

• In fact, have the Tech Writer do the proposal!

Tom Murphy Services 7