Steps to Technical Writing

steps

  • Read the Marketing Requirements Document (MRD) and functional specification.
  • On the basis of MRD and functional specs, create a documentation plan that includes:
    • Product name, scope, and purpose
    • Milestone dates
    • List of documents that will be created and/or updated. If the project is about updating an existing product, list the features to be documented. If the project is about releasing a new product, additional planning is required. There are multiple customer documentation deliverable types a project could require, ranging from a single-paged addendum to a context-sensitive online help system.
    • Features that will be documented
      Work estimate and committed schedule for documenting each feature or completing each document
    • Committed documentation milestones
    • Documentation Reviewers including review schedule. There are several ways to conduct a review. Collect edits individually from each reviewer, or hold a review meeting to review everyone’s comments. Multiple reviews may be required. You can also use Adobe’s Shared review process to collect feedback from multiple reviewers.
    • Depending on the program, include any training material needed for the Launch.
    • Risks, assumptions, and dependencies. Include the following: Main risks of the documentation project (e.g. last minute feature additions), probability of each risk, Impact of each risk, Risk mitigation plan, Owner of the mitigation plan,
      Affected BOMs and/or document numbers
    • Doc approval process and approvers
    • Documentation delivery and distribution plan.
  • Distribute the plan to the core team members: PLM (Marketing), R&D lead (Engineering), and PM (Program Manager) who will review and approve the plan.
  • After the approval, create the draft document. Attend core team meetings, interact with the application, study design documents, ask questions to the testers/developers.
  • Send the draft to the reviewers identified in the documentation plan.
  • Update the documents as per the review comments, address all the major and critical documentation CRs and defects identified during the documentation validation.
  • Obtain the documentation approval from the designated reviewers/approvers.
  • Generate the final version.
  • Check in the final document into the build branch.

Contact Geenu Ann via email info@ThomasEcafe.com to explore creating technical content.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s