B.E.Sc., P.Eng., IT Procurement, Technical Writing

Technical Writer

BUSINESS PLANs

Apply industry knowledge in the preparation of technical propositions, plans and engagements.

Describe eligibility criteria and define scope of projects.

Describe the market segment, technical objectives, state of knowledge and deviation from standard practice, as well as the steps carried-out in any experimental processes.

Describe the environmental assessment, in terms of the industry and the market

Append supporting evidence, such as research plans, test results, prototypes, emails etc.

Research publicly available sources for contemporaneous evidence.

Outline the Critical Success Criteria and describe the benefits of the outcome.

SOPs

Facilitate operational correctness and smoothness by preparing Standard Operating Procedures (SOPs), whereby best practices and job aids are implemented.

Gather and organize complex technical content from Subject Matter Experts (SMEs) into easily readable text, tables, charts, and graphics

Support the collection, review, and version tracking of procedures

Ensure accuracy and completeness of documentation in terms of grammar, style, context and spelling

Create a process map for each SOP

Facilitate routine priority meetings with all business units to establish technical specifications

Analyze changes to determine need for revisions in previously published material and development of new material

Inform applicable business areas of SOP updates and publish content to the intranet site

Gather, analyze and compose information provided by subject matter experts (SME).

Conduct research and ensure the use of proper technical terminology.

Translate SME information into clear, readable documents and process maps to be used by users

Ensure consistency, clarity, and quality in and across all types of documentation.

Engage in formatting, editing, and quality assurance on own work and the work of others.

Ensure documents are technically and mechanically accurate and consistent with regard to clarity, flow, organization, completeness, and readability.

(SMEs) to prepare new, or changes to, existing Policies, SOPs, and Work Instructions as part of an overall document harmonization and integration project.

Implement the document workflow process as a formal written procedure and, as well, support the development and revision of procedures by applying document standards.

MARKETING

Preparing effective presentations and proposals in response to technical requirements and specifications.

Define the solution and create simple and concise proposal content

Prepare price estimates for design, development and deployment of solution

Describe the solutions, including executive summary, technical requirements, delivery plan, high-level delivery schedule, etc.

Create architecture / network diagrams suitable for proposals and presentations

TRAINING

Creating innovative instructional design and training content and material for online training modules and programs, as well as providing well-organized and structured documentation to ensure ready accessibility and material currency.

Create online training content and documentation including audio/video scripts

Create functional feature and workflow/process descriptions

Gather and organize information from Subject Matter Experts, existing documentation, user stories, and Developer’s documentation to create Training Modules/Courses, Implementation Guides, Technical Configuration Guides, Release Notes, User Guides, What’s New Guides, Quick Reference Guides and so forth.

Work closely with Technical Business Analysts, Subject Matter Experts, Developers, Product Managers, Client Services staff, and Management to fully understand and document implementation processes, product features, and product enhancements

As new builds are released, ensure changes are applied to existing guides and training materials

Actively participate in the design and implementation of the knowledge management system

Ensure version control is adhered to for auditing purposes

Maintain repository of documents and content

Participate in daily Agile scrums and iterations meetings as required

Publish documentation and announce new features and enhancements

Prepare custom help content guides as required

Log software bugs found during the documentation process and verify closure through Rally

Acquire product feature knowledge [and back fill it] in order to document activities.

Through collaboration, standardize configuration documentation and product settings.

Attributes

Relevant work experience; technical writing and/or editing experience

Experience in creating business processes and procedures

Excellent critical thinking skills

Adherence to organizations’ procedures, standards [including, correct application of templates] and priorities

Assurance of consistency in language and style

Team work with skilled engineers, scientists and business professionals, as well as the ability to work independently and proactively.

Proficient in oral and written communication

Ability to articulate, negotiate and support technical views.

Ability to conduct technical interviews to assess technical activities.

A flare for communicating in the written form and a passion for creating innovative training content and material

Multimedia formatting, including audios, videos, web medium, tutorials and online help.

About DITA Principles

DITA incorporates features designed to improve the quality and efficiency of documentation. Information typing is a methodology, which underpins DITA. Information is structured by topics with content models appropriate to the nature of the content. The three base DITA information types are concept, task and reference.

The Darwin Information Typing Architecture or Document Information Typing Architecture uses the principles of specialization and inheritance, which is in some ways ...

The latest version of DITA (DITA 1.3) includes five specialized topic types: Task, Concept, Reference, Glossary Entry, and Troubleshooting.

In a test project for the DITA L&TC Specialization, a team at IBM studied content with good learning architecture, following DITA principles and best practices,

Introduction to DITA - Oxygen XML Editor

https://www.oxygenxml.com/dita/styleguide/webhelp c_Introduction_to_DITA.html

DITA incorporates features designed to improve the quality and efficiency of documentation. Information typing is a methodology which underpins DITA. Information is structured by topics with content models appropriate to the nature of the content. The three base DITA information types are concept, task and reference.

Contact this candidate