Based on the project, our technical writers will masterfully perform the roles and tasks described.
A PTIGlobal Manager or Lead meets with Client to define the project, roles, tasks, schedule, project tracking methods (tools, spreadsheet, and so forth), authoring tools, publishing tools, repository tools and processes, review tools and processes, and any special considerations.
The Manager or Lead ensures the technical writer(s) assigned are properly trained to meet the project’s needs.
The Technical Writer (TW) and Client agree on authoring tools, templates, content outline, repository, and method for the Client to enter technical content into the template. The Client and TW agree on file access dates and editing/reviewing schedules. This includes schedules for accessing text, illustrations, tables, repurposed content, and more.
The Client and TW agree on the editing tasks, such as level of edit, formatting needs, legal disclaimers, terminology, and final production edit. Technical accuracy is addressed during the Review process.
The Client and TW may also discuss aligning the content for localization by ensuring consistent usage of technical terminology, grammar, formatting, word choices, and illustrations.
Ongoing Status Reports
Throughout the project, the Client and TW share reports on project status. This step may include highlights and lowlights, project phase completion notes, work in progress, stalled or blocked elements, and other classifications.
As a rule, the Client and SMEs focus on technical content accuracy, and TWs focus on editing roles.
The Client and TW agree on review methods, such as collaborating on shared review PDFs or Word documents with tracked changes. The review team is identified, feedback compiled and validated, and source file updated with changes. Typically, additional editing and formatting tasks are required after the review cycle. In addition, multiple review cycles are sometimes required.
Whether delivering the finished content internally (Deliver) or posting the finished content to a public-facing portal (Publish) the Client and TW ensures the content is polished, and the TW uses the appropriate tools to deliver and publish the publication.