• Become a Fan!
  • Follow On Twitter
    • Subcribe to Our SMS Channel

    Technical Documentation Plan

    Posted In Tech Writing - By Sudipa Sarkar On Wednesday, November 19th, 2008 With 0 Comments
      



    Technical documentation plan describes all the components of a documentation project.

    A documentation plan should contain information about the following:

    • Product Description: A brief summary of what the product does.
    • Audience: Characteristics of users who would be using the product.
    • Deliverables: The names of the documents that a technical writer will create and deliver
    • Receivables: What the writers and other documentation team members need from others
    • Style: Style guidelines to be followed such as in-house style guidelines and the Chicago Manual of Style.
    • Tasks: Tools to be used by the documentation team
    • Schedules: A schedule for each deliverable. It should include dates for reviewing, editing, illustration, indexing and preparation of the final output.

    -Sudipa Sarkar

     tech writing  Technical Documentation Plan

    Sudipa Sarkar

    Sudipa is professional content writer, working in an MNC. She also writes professional resumes for a leading resume writer company in India. Her expertise are both technical and general contents.