Review of DITA Authoring Software

Of all the technical writing tools I’ve used over the years, Epic Editor was probably the most impressive, especially when it came to doing tech documents that involved DocBook and Dita. It was difficult to learn – no point pretending otherwise – but once I got the hang of it, I used it non-stop for over 2 years. Then I switched companies are haven’t had the opportunity to use it again. With that in mind, here is a brief intro to EPIC Editor, Ivan’s favorite XML Authoring Software!

Update:  Epic Editor is now called Arbortext Editor. You can learn more over here: http://www.ptc.com/products/arbortext-editor

Document Types

First up, let’s define a document type. According to EPIC it “refers to a collection of files that together create an application for creating and publishing documents.”

Examples of different document types include:

  • Schema or DTD
  • Stylesheet(s)
  • Sample and template instances
  • Configuration files
  • Programming files that further customize the authoring or publishing environment

Document Types available

EPIC Editor supports the following types:

ATI XML DocBook — version of the DocBook DTD extended to provide profiling and equation editing.

  • ATI Simplified XML DocBook Article — extended to provide profiling and equation editing.
  • ATI Very Simple XML DocBook Article is a schema-based (.xsd) XML document type based on the ATI Simple XML DocBook Article. This document type has no DTD.
  • ATI Catalog is an Arbortext-developed document type, based on DocBook 4.0, for catalog applications.
  • Article is an article format based on ISO 12083.
  • DITA Concept, Reference, Task, and Topic — the primary categories used for technical documentation.
  • Book – book format based on ISO 12083.
  • DocBook V4.0 – used for computer software documentation.
  • News Release – format for preparing news releases.
  • Correspondence – for business letter or memo format with several styles to choose from.
  • General Purpose Document  – reports, books, and other types of documents.
  • ATI-MIL-M-38784C – CALS standard document type.
  • HTML V4.01 – for publishing information on the web.
  • XHTML V1.0.
  • Free-form XML – for creating valid XML documents that do not have schema or DTD declarations.
  • ASCII  – standard unformatted text character set.

How does it work?

The interface is simple and lets you get at the XML tags very easily.

This screenshot shows the results of a test on the clarity of the document (ie its readability) and the number of words.

epic-editor-file-statistics

Next is the toolbar.

epic-editor-toolbar

This offers a range of features that should keep most all Technical Writers satisfied if they want to develop nice, compliant XML and DocBooks.

Note that you can create tags, split sections, insert tags, and check their integrity.

EPIC Editor won’t let you add tags if they are in the wrong sequence. It this sense it can be very unforgiving – but it is simply trying to retain the integrity of the underlying code. Once you understand how XML works, it gets much more intuitive.

You can also import text files from your PC and add them to the document set.

epic-editor-import-text-file

Once you have the document ready, you can compile it to Windows Help or transform it to:

  • ASCII
  • DITA
  • Docbook source
  • XHTML

You can also add entities and prolog definitions, but this is more for advanced users.

epic-editor-format-text

Tip: you can also select part of the text and validate it only.

Here you can insert markups into the content, usually as tags.

epic-editor-insert-markup

Preferences

You can configure it in different ways. For example, you can ask it to show Attributes, Comments, and Tag prompts. Whichever suits your style of working.

epic-editor-preferences

This gives you an idea of how it checks the xml code. Work your way through the errors and fix each one after reviewing it.

epic-editor-check-completedness1

Like I said, I haven’t used this for a while. Let me know if you’ve used it recently and seen any changes.

How does it compare to other technical writing tools you have used?

Download these templates to start

Acceptance Test Plan

Contingency Plan

Software Development Templates

Acquisition Plan

Conversion Plan

Software Requirements Specification

Action Plan

Cost Benefit Analysis

Software Testing

API Documentation

Database Design

Standard Operating Procedures (SOP)

Audience Analysis

Datasheet

Statement of Work

Availability Plan

Deployment Plan

System Administration Guide

Bill of Materials

Design Document

System Boundary

Business Case

Disaster Recovery Plan

System Design Document

Business Continuity

Disposition Plan

System Specifications

Business Plan

Documentation Plan

Technical Writing Templates

Business Process

Employee Handbook

Test Plan

Business Requirements

Error Message Guide

Training Plan

Business Rules

Expression of Interest

Transition Plan

Capacity Plan

Fact Sheet

Troubleshooting Guide

Case Study

Feasibility Study

Use Case

Change Management Plan

Functional Requirements

User Guide

Communication Plan

Grant Proposal

Verification and Validation Plan

Concept of Operations

Implementation Plan

White Papers

Concept Proposal

Installation Plan

Work Instructions

Configuration Management Plan

Interface Control Document

Software Development Templates

Acceptance Test Plan

Maintenance Plan

Software Requirements Specification

Acquisition Plan

Market Research

Software Testing

Action Plan

Marketing Plan

Standard Operating Procedures (SOP)

API Documentation

Needs Statement

Statement of Work

Audience Analysis

Operations Guide

System Administration Guide

Availability Plan

Policy Manual

System Boundary

Bill of Materials

Project Plan

System Design Document

Business Case

Proposal Manager Templates

System Specifications

Business Continuity

Proposal Template

Technical Writing Templates

Business Plan

Quality Assurance Plan

Test Plan

Business Process

Release Notes

Training Plan

Business Requirements

Request for Proposal

Transition Plan

Business Rules

Risk Management Plan

Troubleshooting Guide

Capacity Plan

Scope of Work

Use Case

Case Study

Security Plan

User Guide

Change Management Plan

Service Level Agreement (SLA)

Verification and Validation Plan

Communication Plan

Setup Guide

White Papers

Concept of Operations

Social Media Policy

Work Instructions

Concept Proposal

Contingency Plan

 

Configuration Management Plan

Conversion Plan