Technical Documentation Tools and Art of Project Migration

Technical Documentation Tools and Art of Project Migration

₹2800
Categories:
Reviews:

About this course

Summary

You can register for one or multiple modules of Technical Writing Fundamentals Course. If you register as group of 3 or select multiple modules then there is additional discount on every module.

The 2-day course module helps you understand Technical Documentation Tools and also how to easily migrate projects while switching documentation tools. You will learn which types of tool to use for your projects and how to finalize a tool for your organization.
In this module, we will also have separate workshops on Markdown and MadCap Flare.

Dates: Jan 29-30

Timing: 2.30-5.30 PM IST

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

How to Register

Fee

  • Fee for this Module (Both Days) – INR 2800
  • Group of 3 or more: INR 2600 each
  • Only for one Workshop: INR 1500

Inclusion in the Course

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

 

Who Should Attend!

  1. All who want to learn MadCap Flare.
  2. All who want to learn Markdown editor.
  3. All who want to understand types of Technical documentation tools.
  4. All who want to learn the art of migrating projects smoothly.

 

Course Structure

Day 1 (Jan 29): Best Practices for Migration of Project + MadCap Flare Workshop

Migration – how to import projects

  • Concept
  • Considerations
  • Tips and Tricks

In-session project with Workshop: Introduction to MadCap Flare and learning how to use the single-sourcing tool to create a new project and publish in the live practical session.

  1. Introduction
    Introduction to MadCap Flare
    UI Walkthrough
    Input and Output Types
    A few concepts/terminologies
  2. Environment
    Create projects using templates
    Folder structure and walkthrough
    Editing/Customizing the Home page
  3. Authoring
    Adding topics
    Structuring using Headings, Lists, Tables
    Inserting Images and Videos
    Creating Links and Cross References
    Topic previews
  4. Designing

    Creating Master ToC and section-wise ToCs
    HTML5: Using Master Pages to add common sections
    PDF: Using Page Layouts
    Preview changes
  5. Publishing

    Setting up HTML5 and Print Targets
    Building Output
    Previewing Output
    Publishing Output

Day 2 (Jan 30): Documentation tools overview + Workshop to learn Markdown Editor

  1. Word-based authoring
  2. Wiki-based
  3. GitHub
  4. Docs-as-code process and tools
  5. Single Source based authoring 

In-session project with Workshop: Introduction to Markdown and learning how to use in live practical session.

  1. Introduction
  2. Creating a project from existing content
  3. Designing using Markdown tags (Styles)
  4. Inserting Image
  5. Adding Table
  6. Using Hyperlinking and cross-references
  7. Publishing to PDF, HTML and MS-Word
  8. Migration

What else do you get!

  • Downloadable toolkit for future reference.
  • Access to recording for practice
  • A guide prepared by you as Portfolio
  • Access to core group for future discussions

 

About the Instructors

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.

 

Shrutika Kalgutkar

For the past 11 years, Shrutika has been making lives easy one piece of content at a time. She specializes in documenting products from scratch, revamping existing documentation sets, and UX writing.
She enjoys challenges and at her current organization, took it upon herself to migrate the entire documentation set consisting of 4 products to MadCap Flare from scratch. With MadCap Flare, she specializes in setting up doc environments, designing sites, creating styles and templates, and creating content.

Members

Our course begins with the first step for generating great user experiences: understanding what people do, think, say, and feel. In this module, you’ll learn how to keep an open mind while learning.

Total numbers of students in course
%d bloggers like this: