Technical Writing

Requirements and Specifications

TechRepublic has reported (as have so many others) that 68% of IT Projects fail because of poorly written requirements; dooming projects right from the start.

Poorly written requirements (business, stakeholder, functional, non-functional, transitional) cause confusion, re-work, cost and failure because needs were not clearly translated into understandable and clear requirements.

The failure, TechRepublic reports, comes from organizations’ ‘over-estimating their capacity’ in this area.’ This is understandable, considering that the vast majority of Business Analysts have no background in technical writing or communications.

Such failure is to be expected, and repeated studies bare this out. 

User  and Technical Documentation

User documentation (paper, online, video) provides end users with procedures and ‘know how’ to use a product or service.

Technical guides and manuals (system administration, run books, build guides, specifications, architectures, API/SDK, etc.) describe how a product or service is constructed, administered, and operated.

Traditionally, user documentation was provided as a user guide, manual, and later online help.

Today, user documentation is increasingly being delivered online through video on YouTube and organization sites as organizations look to cross-market their user education and product assets to gain greater exposure and visibility of their product offerings.

User documentation delivered through video has great impact because the user can actually see what to do.

RFP and Proposal Development

The RFP document, its supporting processes, and the comprehensive response form the foundation of successful, repeatable, fair procurement.

A properly constructed RFP clarifies technical goals, communicates administrative and financial expectations, and sets the tone for good communication, and a trusting, productive relationship between the customer and the contractor.

I follow a systematic, comprehensive and professional approach to writing RFPs that elicits high quality responses from potential contractors.

Content Marketing

Content marketing takes a strategic marketing approach focused on creating and distributing valuable, relevant, and consistent content to attract and retain a clearly-defined audience to drive profitable customer action.

A brand must give something valuable to get something valuable in return. Instead of the commercial, be the show. Instead of the banner ad, be the feature story.

Marketing has changed enormously over the past decade. People buy differently, so we need to sell differently. Marketing with valuable content has developed as a way to bridge the gap between the way people like to buy (researching online and via recommendations from social networks) and the way smart businesses like to sell; by demonstrating empathy, purpose and usefulness; not by shouting loudest.