What happens when source content is bloated? DITA, minimalism, and agile development.
DITA, minimalism, and agile content

Helping Writers Succeed with Great DITA, Minimalism, and Agile Content

Too often, when we work on a DITA implementation we spend a lot of time on the bells and whistles of our CMS or the DITA-OT publishing scripts. But, often the content is bloated, uses unsemantic markup, is riddled with duplication, and suffers from condition overload. If this is the case, you won’t get the benefits. Bottom line: DITA, minimalism, and agile development are powered by robust, semantically correct DITA content.

It’s not just that you won’t be getting all the benefits. Having messy content sets up your writers for failure and frustration.

The meals are pretty poor but then they never use fresh ingredients – garbage in, garbage out.

DITA isn’t delivering as promised. Garbage in, garbage out certainly applies to the DITA-OT.

Remove/Edit/Repair/Prune (RERP) Bloated Content

Remove/Edit/Repair/Prune (RERP) redundant hyper-conditionalized content with lots of duplication and arbitrary differences in the content is absolutely needed to realize the benefits of DITA.

With bloated non-semantic content you will be unable to achieve your business goals (faster turnaround, faster translation, lower translation cost, fewer errors, more reuse, etc.).

Are technical writers the best agents of change for DITA, minimalism, and agile content?

How much can you rely on writers/editors deeply embedded in the product teams to be the blunt destroyers of duplication that we so much need?

In general (and there are always exceptions), the greater the portion of the remove/repair/prune burden that we impose on writers/editors, the lower will be the benefits.

In other words:

↑ Reliance on embedded writers → ↓ RERP benefits:

↓ Slower migration

↓ Ability to support reuse

↑ Frustration and conflict with product teams

↑ Frustration for writers and editors

↑ Translation costs

↑Turnaround time

Why tech writers embedded in the product team may not be the best DITA change agents

The more that we rely on embedded writers to get great DITA, minimalism, and agile content, the more disappointed we will be in the results. This is true for a few reasons, including:

We are humans, and we have relationships. When we RERP we will be brutally pruning the content of our colleagues, people that want to like us. Each degree that the RERP team is removed from the content owners, the easier it will be to be brutally effective.

Deconstructing someone else’s work is much easier than deconstructing your own. (This is why publishers have editors!)

Embedded writers will need time to scale up to the required new skill sets (minimalism, conref’ing, applying conditions within reused items where possible, creating reusable chunks in content banks, applying semantic markup, and more). The greater the share of RERP on embedded writers, the smaller will be the benefit and the longer the delays. (When a dedicated team handles RERP, each team does not have to repeat rookie mistakes. Roughly translated folk expression: you don’t have to learn how to shave on your own cheeks.)

Change is hard. Big change is harder. There are lots of talented writers on your team. Some of them will get with the program out of the gate. Most of them will require time. By reducing what we ask of individual writers, we can get them to the desired skill levels and new mindset faster.

So, what is the alternative?

For RERP, here is a proposal: FreezeRERPThawEnhance

  1. Selected Content Freeze – Content is selected for RERP, it is frozen. (For example, from Thursday to Monday – or any two or three work day period.) During the freeze, no changes may be made to the content by writers.
  2. Selected Content RERP –dedicated RERP team. During this period, they may ask questions of the content owners.
  3. Selected Content Thaw –CMS expert (or content owner or dedicated RERP team) returns or uploads the content to the CMS. Makes sure that duplicate content is archived or removed.
  4. Content Enhancements –with the new content in the CMS, writers seek further advantages/efficiency gains:, more paring down, referring to newly created conrefs, etc.

I would love to hear your experiences and thoughts! Click here to learn more about how many ideas to put in single DITA topic.

 

How to add a DITA specialization to oXygen Editor or oXygen Author

Congratulations. You just got your brand new DITA specialization. And, you want to use it.  Follow these instructions to successfully integrate your DITA Specialization to oXygen Editor or oXygen Author.

These instructions apply when the DITA specialization is available as a DITA Open Toolkit plugin. Read more

Information Architecture

information architecture

Use our DITA information architects to help you succeed.

Here are just a few of the issues that our expert information architects will help you work through:

  • How will your DITA implementation affect your ability to publish translations quickly and inexpensively?
  • What choices can you make for content reuse that will affect your ability to single source without burdening writers?

Read more

DITA Training and Support

DITA Training

Learn DITA best practices and make the most of your DITA implementation

Method M provides end-to-end support for organizations moving to successful DITA implementations. Our services include training in DITA best practices for writers and editors, information architecture, DITA specializations, conversion to DITA, and publishing support for PDF, web, mobile and custom formats. Read more

oXygen Author and oXygen Developer

logo_oxygenMethod M supports an array of tools for technical authors, including oXygen Author and oXygen Developer. Method M supports your writers with best practice training, templates, customizations, XMetaL macros, implementation coaching, and much more.

XMetaL Author

xmetal logoApply best practics for XMetaL Author. Learn how to use maps, topics, elements, attributes, customizations, macros, automation and much more. Learn the best methods for single sourcing in XMetaL. Choose the functionality that will deliver the best results for your environment, including conref, keyref, and conkeyref.

Method M DITA Consulting

Considering a move to DITA-based publishing? Backed by years of experience, we guide your project to successful implementation. Whether you need training for your team in DITA, or in using DITA editors such as oXygen or XMetaL, need information architecture to help you succeed, or help customizing your deliverables – we are here to help. Read more

Method M DITA Workshop

The DITA workshop will equip you to evaluate, plan and start implementing the Darwin Information Typing Architecture (DITA). In this workshop you will learn: How to author topic-based, well-structured technical information. How to assemble and publish delivery documents from topics. How to evaluate your needs and choose from standard DITA information types (concept, task, and reference). Plan […]

Key facts about DITA

dita-logoDITA (pronounced dit-uh) is an acronym for:

  • Darwin—DITA can evolve to account for your particular authoring needs. (Specialization in DITA jargon.)
  • Information Typing—DITA was designed for core types of technical content: concept, task, and reference.
  • Architecture—DITA provides a framework for designing and delivering technical content efficiently.

Read more