Technical Documentation

HOME

Technical documentation is either the first or the last stop for users looking for authentic information. The importance of accurate documentation cannot be exaggerated. The Cybage Documentation team is aware of the crucial role it plays while acting as a bridge between the originators and the adopters of a product.

IT applications and systems are used globally. Although localization of content is the best way to communicate with locale-specific users, it can prove to be costly. So, English becomes an obvious choice when writing for a global audience. In this case too, the recognized idioms and the favored expressions vary from region to region. However, technical documentation is about presenting information in a language or manner that is accessible to a wide audience without leaving any room for ambiguity, bias, and uncertainty.

The Cybage Technical Documentation team is at ease writing for an international audience. We adhere to well-known style guides that enunciate principles of effective documentation based on usability studies. We follow Microsoft Manual of Style for Technical Publication, Chicago Manual of Style, Sun Style Guide, or the client’s in-house style guide to create effective documentation. Based on the client’s requirements, we suggest using a simple text editor such as Microsoft Word or feature-rich authoring tools such as Adobe RoboHelp, Adobe FrameMaker, or MadCap Flare, which provide single-sourcing capabilities.

Sometimes, combining elements of eLearning and technical documentation heightens the user’s engagement. Multimedia and product demos can help cover a lot of ground and prepare the user to derive the most from technical documentation. The Documentation team is adept at using rapid authoring tools such as Adobe Captivate and Articulate Storyline to create demos that can be embedded in content pages or delivered as standalone learning resources.

Good documentation can reduce the number of calls made to customer care and empower users to get started on their own. To ensure high quality of user guides and technical manuals, we follow a robust four-phase methodology for our technical documentation services.

Requirements gathering

  • Understanding the audience
  • Gathering product knowledge through source documentation and presentations
  • Gathering required information from the in-house team and the team at the client’s end

Analysis and design

  • Analyzing project-related documents
  • Designing the document plan
  • Designing templates or modifying the existing templates
  • Defining the structure, the layout, and the overall look-and-feel of the content

Content creation and review

  • Creating accurate, user-friendly content
  • Undertaking peer review, technical review, functional review, and client review for the content
  • Incorporating review feedback
  • Preparing the final deliverable

Delivery and deployment

  • Sending the deliverable for final client review
  • Incorporating feedback from the client
  • Obtaining sign-off
  • Deploying the deliverable

Documentation deliverables

We create the following types of software documentation deliverables in industry-standard formats such as CHM, PDF, ​WebHelp, Java​​Help, HTML, and SWF:

  • User guides
  • Administrator guides
  • Installation guides
  • Configuration and deployment guides
  • Product manuals
  • Online help
  • Technical notes
  • Release notes
  • API or SDK manuals
  • Knowledgebase articles
  • Product and multimedia demos

Documentation tools​

Our strength lies in our ability to use the latest documentation tools. In addition to the following authoring tools, we also use various tools and mechanisms for project management, conversion, image editing, and version control to complete a deliverable and guarantee quality documentation services:

  • Adobe RoboHelp
  • Adobe FrameMaker
  • MadCap Flare
  • XMLmind
  • XML oXygen
  • DITA-OT
  • Snagit
  • XMetaL
  • Doxygen
  • Adobe Captivate
  • Articulate Storyline
  • Microsoft Word

Thought Leadership

TESTIMONIALS

Michael Meyer Testimonial

Michael Meyer talks about how Rate Highway Inc. has learned...

President and CEO,
RateHighway Inc.
Guy Amoroso

Ten years of relationship speaks volumes...

Managing Director,
123Insight Limited
Patrick Bustraen

We chose Cybage as the software partner and we had...

VP - R&D,
Transics International
Pontus Rogala

The domain understanding of Cybage experts...

Managing Director,
Airfair Flugservice GmbH
John Oberon

Cybage respects its customers' views and inputs...

VP - Engineering,
Intel(Mashery)
Vineet Gupta

Cybage has flexible functioning and friendly culture...

EVP & CIO,
Fairmont Raffles Hotel International
Robert Nix

Cybage team is a part of our company. Our 9 year old...

VP & Principal Architect,
AthenaHealth Inc.
Greg Wiggins

We are impressed with the Indian engineers' way of...

Director - Software Engineering,
Central Logic Inc.
Steven Knapp

Cybage has proven to be consistently reliable since...

SVP - Global Operations,
iCrossing Inc.
Dave Johnson

No team in Cybage works in silos. Our decision...

COO,
iCrossing Inc.
Howie Altman

The delivery team at Cybage has much higher quality management...

VP,
TravelClick
Frank Van Amerongen

The preciseness and quick reaction by Cybage team adds to our business...

Publishing Director,
ThiemeMeulenhoff
Harvey Goldhersz

The stability provided by Cybage has helped us scale-up...

CEO,
GroupM Analytics
Ben Bartel

Cybage's skilled team has helped us in developing healthcare solutions...

VP - Product Development,
Marketware Systems
Donal McGranaghan

Cybage provided us the transparency, and the efficiency of the delivery...

VP - Software Engineering and Quality,
DealerTrack