Basic Skills

Problem Description

Our high-skilled specialists estimate your documentation problem and offer key decisions on the way to effective development of easy-to-use set of technical documentation. Our decisions are based on the three aspects of how the future documentation is planned to be used:

• Who's going to use this documentation?
• What's the purpose of this documentation?
• How deep it goes into detail?

Our purpose as technical writing team is not to show how complicated your matter is but to show how easy it might be to understand for your end user or customer - due to our documentation.

Organization of the Documenting Process

We're here to answer the key questions of process optimization. When should the documenting start? Who is to be involved in the documenting process in your particular situation? How many members the documenting team should have? Where the information comes from? Is it better for your situation to make the documenting in-house or outsource process?

Documentation Standards

Our company pays a lot of attention to local and international standards used for technical documentation. More than often standards help to put previously quite irregular documentation corpus into perfect order. We used to develop the documentation under both national Russian standards and ISO/IEEE standards as well as help companies create their own standards for technical documentation.

Quality Criteria

If you never know what's your client or end user going to think about your documentation because they never make any clear criteria, our situation is completely different. Our documenting experts created a set of criteria to estimate the quality of technical documentation and use them every time in their work.

Instruments

We use each and every modern-technology tool for creating or publishing the technical documentation. We work with Microsoft Word as well as Adobe FrameMaker, WinHelp and other HTML help editors, Single Source technology based on DocBook XML etc.

Documentation Development

Our technical writers work efficiently at every stage of the development process. We start with collecting information, preliminary documents and interviews, then proceed to systemizing the knowledge and filling in the lacks, building the terminology system, and then, coming up with the document structure. After that, the document is gradually being filled with the information, including screen shots, charts and schemes in the end.

Different Documentation Types

We work with every type of technical documentation including published documents as well as help systems or e-publishing. Our experts provide every document you need:

• User Manualscomplete but easy-of-use information for your end user
• Administrator Guides-thorough description of the complex administrative functions for a complicated system
• Installation Manuals-every piece of installation information for the needed level of reader
• Product Descriptions-easy to detach the advantages and peculiarities of your product
• White Papers-marketing documents for the wide audience
• Help Systems-embedded in the system or self-contained
• E-Portals-including the most complete information on your system easy to browse and control due to hypertext