Documentation

A technology product begins as an idea expressed in language. Technical writing is concerned with rendering such ideas in a usable format for a selected audience and purpose.

We can help you formulate and realize all of your documentation needs, from project documentation to end-user materials to marketing collateral to web content.

Project Documentation

Before the idea can be realized, it must be formulated and communicated. Decisions made during the realization process must be recorded, distributed, and understood by all concerned. Records of the realization process must be archived and made available to future developers to enable maintenance and further development. All information needed to roll out the end product must be assembled and distributed to interested deploying and supporting parties.

Design, build, maintain, deploy, support: these are the areas of concern for project documentation. You can think of documentation as a project within the project. It is a parallel undertaking that adds value.

We can help you harness the information produced by your development efforts and make it available, according to your needs, to audiences both internal and external.

End-user Documentation

The end product of the development process may be a marvel of modern technology, but it must be made accessible to those for whom it was intended before it can be considered usable and marketable. We can write user guides, online help, and technical reference manuals to suit your needs.

Content Development

Because we are developers ourselves, we have a well developed understanding of the nature of technology, technology products, and the business of technology. We use this understanding in consultation with your professionals to produce content that captures the essence of your products and business strategies.

We can help you develop copy for sales and marketing collateral from the inside out.

But you have to go beyond the marketing hype too. You have to develop web content to retain the interest of those attracted by your sales and marketing.

It has often been said that, in the new economy, knowledge is sacrificial. What this means for organizations trying to promote technology products is that they must give in order to get.

The content that you provide on your Web site cannot be entirely self-serving. It must be substantive enough to interest those attracted to your site so that they will return and bring others with them.

We can help you develop thoughtful content and useful white papers that will serve both you and your customers well.

Editing

There are two maxims that apply to all writers. The first is that every writer needs an editor. The second is that no writer believes he or she needs an editor.

Perhaps you have performed some or all of the activities described in the preceding paragraphs and you just need someone to validate your work -- another set of eyes to look at structure, sense, completeness, usability, grammar, punctuation, and even spelling.

We can provide eyes for every occasion.

Contact Us

If any of the scenarios on this page apply to your organization, consider contacting us to discuss your needs and what we can do for you.