STRUCTURED AUTHORING FORCING PEOPLE INTO STANDARDS, ONE DOCUMENT AT - - PowerPoint PPT Presentation

STRUCTURED AUTHORING

FORCING PEOPLE INTO STANDARDS, ONE DOCUMENT AT A TIME.

UNSTRUCTURED & STRUCTURED AUTHORING

• Microsoft Word documents or

Google Docs

• Formatting applied by the author
• Reuse occurs via copy-and-paste or

re-creation

• Static, locked in format
• “A publishing workflow that lets you

define and enforce consistent

• rganization in documents”
• XML & DTD (we’ll get to that soon!)
• Formatting controlled by

programming, differentiated by purpose in document.

XML & DTD

Extensible Markup Language (XML)

• Think of it as the cousin of HTML,

except you get to choose what the tags are.

• A document is only valid/usable if it

matches its corresponding DTD Document Type Definitions (DTD)

• Provides the actual structure for the

document, outlines which order the elements can take.

IN OTHER TERMS

WHY STRUCTURED AUTHORING?

• Output into multiple file formats (in

both a user guide and online help, for instance)

• Control formatting of documents,

eliminating error or personal preferences

• Creates inherent workflow

WORKFLOW ROLES

• Document Architect: defines and

implements the structure; identifies information types

• Template Designer: establishes the

look of content deliverables

• Writer: creates content, may fill the

role of template designer

• Technical editor: focuses on word

choice, grammar, organization rather than developmental edit

TOOLS OF THE TRADE

• Adobe FrameMaker
• Quark
• MadCap Flare
• (and many more XML editors)

WHY IS THIS USEFUL TO CONTENT MANAGERS?

• Streamlining & content automation
• Reduces the time spent making content
• Improves quality and consistency
• Reduces costs
• Facilitates compliance