Documentation

  • Documentation is crucial to a user’s engagement with a product. The rapid adoption of IT tools and applications—to the extent that we cannot imagine a world without them—is largely owing to the availability of documentation.Invansys adopts a holistic approach to documentation. We begin by understanding the client’s business, the target audience, and the processes and standards.

The documentation services at Invansys are broadly classified into three categories:

  • Technical Documentation
  • Funtional Documentation

Technical documentation

Technical documentation is either the first or the last stop for users looking for authentic information.It aims at providing enough information for a user to understand inner and outer dependencies of the product at hand.Invansys Documentation team is aware of the crucial role it plays while acting as a bridge between the originators and the adopters of a product.
We adhere to well-known style guides that enunciate principles of effective documentation based on usability studies.


The technical documentation prepared at Invansys gives an insight of all the processes behind a project including its coding struture,important functions performed,scripts involved and other code related analysis which makes the adoptors of the project more friendly and aware towards it.

Content creation and review

  • Creating accurate, user-friendly content
  • Undertaking peer review, technical review, functional review, and client review for the content
  • Creating code related structures of the project
  • 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

Functional documentation

A functional documentation is a formal document used to describe in detail for software developers a product's intended capabilities, appearance, and interactions with users. The functional specification is a kind of guideline and continuing reference point as the developers write the programming code. A functional specification may also contain formal descriptions of user tasks, dependencies on other products, and usability criteria. The functional specification prepared at invansys for an application program with a series of interactive windows and dialogs would show the visual appearance of the user interface and describe each of the possible user input actions and the program response actions.


The end-users are not interested in learning the intricate details of the software.End-users employ the software to get their job done. They only want to know how they can employ the software for performing a particular task. User Documents give customers the information they need to use the product. They are primarily teaching materials which include some technical explanation. Invansys documentation team uses everyday terms in place of technical jargon, making it easier for the novice or outsider to understand the system. We take proactive steps to ensure that documentation is accurate and consistent.

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

Technical writers at Invansys prepare documents for different types of users. Typically, there are five basic types of user documents :

  • Description Document
  • Installation Guide
  • Configuration Guide
  • User Guide
  • Administration Guide