Collaboration Tools to Help Improve Documentation Processes

Steven Higgssteven_higgs@oxygenxml.com

Collaboration Tools to Help Improve Documentation ProcessesCollaboration Tools to Help Improve Documentation Processes

Agenda● An overview of the Oxygen team's documentation workflow

● Using an issue tracking application (such as JIRA) for collaboration between all departments

● Using Oxygen Content Fusion for collaboration between the documentation team and subject matter experts

● Using Oxygen XML Web Author for collaboration between the support team and the documentation team

● Using a combination of tools (JIRA, GitHub, Web Author) for collaboration between the QA team and the documentation team

● Using Oxygen products and a version control system for direct collaboration between developers and the documentation team

● Using the Oxygen WebHelp system for collaboration between end users and the documentation team

Overview of the Oxygen Team's Documentation Workflow

Oxygen Documentation Process Contributors

Developers Quality Assurance

Support Subject Matter Experts

Documentation Team

Documentation Requirements

Oxygen Products– Oxygen XML Author– Oxygen XML Author for Eclipse– Oxygen XML Developer– Oxygen XML Developer for Eclipse– Oxygen XML Editor– Oxygen XML Editor for Eclipse– Oxygen XML Web Author– Oxygen Content Fusion– Oxygen WebHelp– Oxygen SDK

Output Types● WebHelp● PDF● Windows Compiled Help (CHM)● Eclipse Help● JavaHelp● Website

Oxygen XML Author

Oxygen XML Author for Eclipse

Oxygen XML Developer

Oxygen XML Developer for Eclipse

Oxygen XML Editor

Oxygen XML Editor for Eclipse

Number of User Manuals Needed

- WebHelp- PDF- CHM- Eclipse Help- Java Help

Oxygen XML Web Author

Oxygen Content Fusion

Oxygen WebHelp

- WebHelp- PDF

- Website

30 User Manuals+ =

Oxygen SDK

6 User Manuals

1 User Manual*

Documentation WorkflowDoc Need JIRA Issue

Gather Info

Doc Task

Content Creation

Commit Changes Proofreading

Report Issue

Doc Review

Support

End User

Need MoreInfo

Doc Team QA Team Sys AdminDev/SME Dev/SME

Close Issue Publishing

Documentation Timeline

QA Team Doc Team Sys Admin Doc Team Dev/SME Doc Team QA Team

Gather Info

Doc Task

Content Creation

Report Issue

Doc Review

Support

End User

Need MoreInfo

Documentation Process ToolsIssue Tracking

Atlassian JIRA

Content CreationOxygen XML EditorOxygen XML Author

Collaboration ToolsOxygen Content Fusion

Oxygen XML Web AuthorOxygen WebHelp

File Repository/Version Control SystemGit

Git Repository Hosting ServiceGitHub

Repository GUISourceTree

Issue Tracking / Project Management

Use-Case 1

Using an issue tracking application (Atlassian JIRA) for collaboration between all departments

Gather Info

Doc Task

Content Creation

Report Issue

Doc Review

Support

End User

Need MoreInfo

Collaboration Tools

Use-Case 2

Using Oxygen Content Fusion for collaboration between the documentation team and subject matter experts

http://www.oxygenxml.com/content_fusion.html

Collaboration ToolsUse-Case 2

Using Oxygen Content Fusion for collaboration between the documentation team and subject matter experts

Benefits●Increased Productivity - A very efficient way to collaborate. Provides a simple, intuitive interface for the Reviewers and the Content Author can easily integrate comments and changes with a built-in merge tool.

●Better Quality – It provides an incremental review workflow that is more likely to engage reviewers and lead to more feedback.

●More Control - It allows the Content Author to control the published content while the Reviewer simply proposes changes.

●Mobile Flexibility – Collaborate with anyone and from anywhere. Reviewers only need access to a web browser.

Collaboration Tools

Use-Case 3

Using Oxygen XML Web Author for collaboration between the support team and the documentation team

http://www.oxygenxml.com/xml_web_author.html

Collaboration Tools

Use-Case 4

Using a combination of tools for collaboration between the Quality Assurance team and the documentation team

● JIRA● GitHub● Oxygen XML Web Author

Collaboration Tools

Use-Case 5

Using Oxygen products & a version control system for direct collaboration between developers & the documentation team

Collaboration Tools

Use-Case 6

Using Oxygen WebHelp for collaboration between end-users and the documentation team

Release Timeline

master

Release18.1 Release 19.0

hotfixes/18.1

hotfixes/19.0

Next release

new 18.1 build new 19.0 build

Git Support Plugin

http://github.com/oxygenxml/Oxygen-Git-Plugin

Provides support for committing changes directly from Oxygen, comparing and merging changes, and other Git commands

Thank You!

support@oxygenxml.com

Email us with details of your specific workflow and requirements

About the AuthorBackground:

● 15+ years experience writing documentation.● 2+ years experience with XML.● 2+ years experience with DITA.● 2+ years experience using oXygen

Current occupation:● Technical Writer for Syncro Soft

Collaboration Tools to Help Improve Documentation Processes · 2017. 9. 11. · An overview of the...

Transcript of Collaboration Tools to Help Improve Documentation Processes · 2017. 9. 11. · An overview of the...

Collaboration Tools to Help Improve Documentation Processes · 2017. 9. 11. · An overview of the...

Documents

Transcript of Collaboration Tools to Help Improve Documentation Processes · 2017. 9. 11. · An overview of the...

5 pillars to team's agility

"NE Team's Project" po polsku

Communicate to invigorate your team's performance

Healthcare team's autonomy: Social management as integrative … · CSR + EFQM Healthcare team's autonomy: Social management as integrative factor VISION VALUES POLICIES ETHICS .

Seek & Destroy Your Team's Productivity Killers

Your Team's Got Talent! Performance Gap Analysis

LXM Sponsor Deck (FOR TEAM'S APPROVAL)

A Social Media Creative Team's Dream Brief

SocialWin Report: UK Soccer's Team's

SocialWin Report: Soccer's Team's Italy in social media

The Willis Team's Seller's Book

ELET 477-Top Team's presentation

My experiments with enhancing team's skill & learning vf0

Set up your team's account on Oxygen

NE Team's Project in English

U.S. women's national soccer team's EEOC filing

Behavior-Driven Design: One Team's Exploration

CAPSTONE DOCUMENTATION - University of Idaho Design/Proj… · PORTFOLIOS What and why? •A team portfolio is a living record of the team's progress. •A well built portfolio will

Nursing Documentation - WordPress.com · Nursing students can enhance their critical-thinking skills by examining and analyzing the records of the health care team's plan of care,

Brigade Combat Team's TOE