Sunday, 31 May 2015

Documentation Development Life Cycle (DDLC)



DDLC is the process of developing the document. It is necessary to develop the document for enhancing the clarity and understandability by which end-user can easily interpret the document. The Document Development Life Cycle is comprised of steps which are given below:
  •  Requirement Analysis
  •  Designing Phase
  •  Developing the content
  •  Editing / Proofreading
  •  Publishing
  •  Maintenance


Requirement Analysis: -  It is the process in which we gather the information of product from product requirement, online help, and SME etc. We analyze the criteria of producing the product according to the audience. In Audience analysis, we analyze who will use this product, what is the need of creating the product, and measures of skill and expertise of the Audience etc. Technical writers gather information from Subject Matter Expert (SME). In every company, SMEs are there for particular domain that is telecom, finance, and medical etc. Software developers can easily understand the requirement from SMEs. It saves the time for understanding the product requirement. By understanding the product requirement, we can easily estimate the time, resources and cost of the product.

Designing Phase: - In Designing phase, Technical writers design the document by proper format, style and layout. Technical Writers create the document with Help Authoring tools that are Robohelp, Madcap Flare, Help N Doc and Author it etc, Screen Capturing Tools that is Snag it, Snipping, Print Screen Tool etc. and Video Capturing Tool that is Camtasia.

Developing the content: - We develop the content according to the product features and requirement. We analyze the product, run the product and write the draft according to that product. Technical Writers create user manual, user guide, reports, and online help, etc. Technical Writers add title, copyright, content, index, glossary, and appendix etc in the manual.

Editing / Proofreading: - Editing is the process in which test the creating project, according to the requirement, and product features. We check the first draft through Technical Writer editor, peer review or the technical review, etc. In this phase, Technical writers check the technical part, grammar mistakes, figures, and format etc.
Proofreading is the final testing of the project by checking proper layout, style and grammar mistakes,etc. In this phase, we check the draft entirely. Our main purpose is to remove bug from the draft, so that document is clear and understandable.


Publishing: - In this phase, we publish the document as online help, and print document, etc. Print documents is the hard copy in which all the content may be in long sentences or paragraph, and screen shots. In online help, we add hyperlinks, and content is in short sentences. These documents are useful to end users to determine the exact use of the product.


Maintenance: - Maintenance is the process in which we add updates, create versions after modification in the project. When a new product comes on the market, then user manual is updated according to the added new feature. Companies also spend cost in creating Support Centers for enhancing user satisfaction.

6 comments:

  1. Thanks for sharing the really nice information .
    Automationshift_ India’s 1st CXO conference on AI & Automation | WTC Bangalore.CXOs share their vision on how they are leveraging AI + automation + machine learning to drive higher efficiencies across organizations #Automation#changes#business#technology within their companies.twbShift

    ReplyDelete
  2. Thanks for sharing the really nice information .
    Automationshift_ India’s 1st CXO conference on AI & Automation | WTC Bangalore.CXOs share their vision on how they are leveraging AI + automation + machine learning to drive higher efficiencies across organizations #Automation#changes#business#technology within their companies.twbShift

    ReplyDelete
  3. Thanks for sharing the really nice information .
    Automationshift_ India’s 1st CXO conference on AI & Automation | WTC Bangalore.CXOs share their vision on how they are leveraging AI + automation + machine learning to drive higher efficiencies across organizations #Automation#changes#business#technology within their companies.twbShift

    ReplyDelete
  4. This comment has been removed by the author.

    ReplyDelete
  5. Ironic that there are so many grammatical and syntax mistakes in this summary of the DDLC process. Otherwise, a good summary.

    ReplyDelete