Technical Writing Authoring

About the Module

The 2-day module helps you understand Technical Writing Authoring concepts, types and processes involved that you practice with multiple exercises.
The module also explains the complete Technical Documentation Review process.
Dates: April 22-23, 2023 (2.30-5.30 PM IST)

IMPORTANT!! Those who have registered for Technical Writing Fundamentals course should not register separately for this Module.


Inclusion in the Course

  • Session = 6 hours in 2 days
  • Helpline = Trainers available to help outside the session duration
  • TWO project activities during the session for participants
  • Reference toolkit for future usage
  • Participation Certificate

Who Should Attend!

  1. All who want to have expertise in Technical Writing Style Guides.
  2. All who want to understand templates of documents.
  3. All who want to understand types of authoring from topic-based to scenario-based.
  4. All who want to understand the ideal Review process and reduce iterations of review.

Course Structure

Day 1: Authoring Types

    1. Authoring Process and Concepts
      • Elements of Document (TOC)
      • Structured
      • Unstructured
      • Minimalism
      • DITA
    2. Elements of documents – TOC, content, visuals, tables 
    3. Authoring Types
      • Modular writing
      • Topic-based Writing
      • Task-based Information writing
      • Scenario-based Writing
      • Feature-based Writing

Day 2: Review Process

    1. Editing & Proofreading
      • Concept
      • Copy Editing and Proof-reading
      • Reader Advocacy
      • Readability Score
    2. Reviewing (Checklists)
      • Type of reviews – self, peer, technical/SME/Product owner, editorial, Stakeholders 
      • Communication plan – due by date
    3. Documentation Quality Check
      • Quality Measurement
      • Readability Index
      • Validations
      • Accessibility

About the Instructor

Punit Shrivastava is involved in mentoring and helping technical writing community for a long time. He prefers sharing knowledge and learning with the focus on having a skilled community. He has 20+ years of experience in the field of writing that spreads across writing for English daily, The Asian Age, and 17+ experience in technical documentation.

Connect on LinkedIn

No Comments

Post A Comment