Technical Writing: Methodology

 

Methodology & Workflow

Our rich and extensive experience with documenting technology has resulted in a field-proven methodology providing direct benefit for our customers. We have effectively implemented this workflow time and again over the course of hundreds of tasks resulting in successful projects and satisfied customers.

The typical project lifecycle follows this pattern in an iterative manner:

  • Initial Research and Project Plan
  • Intake
  • Information Architecture (for complex projects)
  • Outline and Approval
  • Interviewing and Input
  • Document releases: iterative process
  • QA 
  • Approvals 
  • Project Complete

Intake: The Intake phase consists of interviews with SMEs and collation of existing materials which provide the knowledge base for the project.

Information Architecture: For complex projects we undergo an Information Architecture phase which is similar to analyzing and planning a database structure; read more here.

Outline: After that we create an Outline which gives a detailed description of the document structure. This is an important Design tool for working with your organization. As with the System Design for a software system, the outline of a document serves as an efficient method of identifying issues and risks before implementation begins. 

Input: During the Input phase we gather detailed information from the various sources and integrate it into the structure provided by the outline.

QA: All phases (and iterations within the lifecycle) culminate in QA where we ensure that the resulting document matches the objectives set out in the original Project Plan.

Approvals: Sign-off and approvals actually take place at multiple times during the project lifecycle. This ensures that the customer is  aware of the project status at all times and can suggest improvements and changes at any stage of the documentation process.

Documentation Management Server

To facilitate this process we utilize documentation management platforms such as Sharepoint where all relevant  project information and document drafts are stored securely and with version control. Customers have 24x7 access to all project resources and can interact with JBS staff  in real time. After all approvals are received, the document goes through one more rigorous check by our QA staff and is then presented for final approval in order to receive Project Complete status.