Skip to content

product · tutorial

Structured authoring without the XML

Vladimir Kuzin

What is structured authoring?

Structured authoring means writing content as reusable, semantic building blocks instead of free-form documents. The idea has been around for decades — DITA XML formalized it in the early 2000s — but the tooling has always assumed you're comfortable with XML. If you are new to the concept, start with the guide to what a CCMS is.

Topicary keeps the principles and drops the markup. For the research behind this approach, see what 59 technical writers actually say about XML and structured authoring.

Components: write once, reuse everywhere

A component is a block of content — a warning, a setup step, a compatibility note — that you write once and reference from any topic. When you update the source component, every reference updates automatically.

Creating a component

Select any block in the editor, hit the slash command menu, and choose "Save as component." Give it a name, and it's available for insertion anywhere in the project.

Where-used tracking

Every component shows a where-used panel: which topics reference it, in which maps, published to which sites. Before you edit a shared component, you can see the blast radius.

Conditions: one topic, many audiences

Conditional content lets you maintain a single topic that serves multiple audiences. Tag blocks with conditions — by product, plan, platform, or custom taxonomy — and filter at publish time.

In-editor preview

Toggle conditions in the editor to see exactly what each audience will see. No build step, no waiting. The filtered view updates instantly.

Variables: change once, propagate everywhere

Product names change. Version numbers increment. URLs move. Variables let you define these once and reference them throughout your content. Update the variable value and every reference updates.

The import path

If you're coming from another tool, Topicary imports your existing content:

  • Markdown — headings, lists, tables, code blocks, images
  • DITA — topics, maps, conrefs mapped to components, conditions preserved
  • MadCap Flarefull project import with TOC, snippets, variables, conditions
  • Confluence — page trees with macro cleanup
  • Word — .docx with heading hierarchy preserved
  • OpenAPI — 3.x specs converted to reference documentation

Drag a file or zip onto the import dialog. Format auto-detected, preview before you commit. To understand why I built Topicary and the gap it fills between enterprise CCMS tools and modern wikis, read the full story.

Ready to try Topicary?

Start free. No credit card required.