Brief Outline

You can see the snapshot of our process below.

  • Understanding Requirements: It includes clarifying the requirements for Deliverable, Scope, and so on. It also includes clarifying how the product will be accessed, how queries will be answered, what would be the expected turnaround time, and so on. This helps finalize the (approx.) timeline to complete the project. It also includes identifying what tools/technologies to use for required project.
  • Understanding Product: It includes clarifying queries and doubts for complete understanding of product in question. We will appreciate if we can get any reference documents that can help us understand the product.
  • Developing Documentation Plan
  • Developing Information Structure (Table of Contents): It includes developing the initial TOC, getting it approved, and then finalizing (update based on client feedback, comments or suggestions) it. It would form the basic structure of document.
  • Developing Template: It includes developing template, getting it approved for font (size, style, type and so on), layout, spacing and so on, and then finalizing (update based on client feedback, comments or suggestions) it.
  • Developing Document: It includes adding content, and capturing screenshots in the template, and getting the first one or two topics/sections approved to proceed ahead. After approval, complete the content, including all images, icons, notes, cautions, glossary, tips and all such elements.
  • Review and Update Content (Only technical information with respect to product)
  • Review and Update Content (Only language)
  • Review and Update Content (Only Images)
  • Convert to Deliverable Form (Compile to CHM, or WebHelp, or PDF)
  • Develop Index - It includes getting it approved, and finalize (update, based on client feedback/suggestions) it.
  • QA (Adherence to Template, Requirements, Guidelines, Process, Timeline)
  • Update based on QA Feedback
  • Review and Update Content (Overall package)
  • Publish or Release
  • Deliver to Client
  • Seek Feedback
  • Post Delivery Analysis - For any variance in adherence to process, requirements, and timeline