A DITA project gone wrong: How to fight the Daleks
Don’t let the Daleks EX-TERMIN-ATE your documentation plans. Get back on track with Precision Content.
The Whoniverse
DITA is a wonderful documentation standard that takes technical documentation into a new world of possibilities. From re-use to multi-channel publishing, there’s no doubt that DITA is a massive step forward from unstructured content. However, that massive step forward has some fundamental gaps that could leave you flailing for a foothold in a Whoniverse without a Tardis.
Enter the Daleks
There are a lot of factors that go into making a DITA adoption successful, from upper management support to a sound implementation, and it’s not unheard of for a DITA adoption to stall and be abandoned or left to limp along.
Some of the major gaps that DITA adopters have to deal with include
- lack of writing standards
- lack of consistent tag use, and
- lack of end-to-end tools and content strategy.
Unfortunately, the Daleks are ready to swoop (OK, roll in) whenever a DITA project falters to expose its flaws and wreak utter destruction. The Daleks AKA middle management don’t understand the value of the project and how, by applying a little Who-vian hands-on work, things could easily be turned around.
Lack of writing standards
There’s nothing in DITA that says how you should write. There are best practices and there are lots and lots of opinions, but the writers are mostly left to figure out for themselves not only what kind of content should be in each topic type but whether or not to use some elements at all, such as the short description.
Think of DITA as infrastructure; you can use that infrastructure to build whatever you want. But without well-thought-out direction, authors end up
building this …
instead of this …
Lack of consistent tag use
Many departments don’t realize they need to determine a detailed standard on how to use the tags so that each writer is using them consistently. Issues as simple as determining when <wintitle> is used versus <uicontrol>, or which types of tables to use, make a huge difference when multiplied by the number of writers and number of topics written over a few years. If everyone is doing things a little differently, your output is going to be consistently inconsistent. Once you have determined the standard, you need someone to regularly review tag use to ensure everyone actually follows the standard.
Inconsistencies in markup become highly visible, published fodder for your Daleks to use against you.
Lack of end-to-end tools and content strategy
DITA includes no tools and no content strategy. Departments have to patchwork assemble their assembly of tools and the content strategy that overarches them all. Improper identification of requirements or a poor content strategy can you lead you down a one-way road towards poor tool selection. Once you’re locked into a poor tool (or worse, two poor tools trying to work together), the effect can be insidious. Authors may spend more time fighting with the tools than authoring content and may still not be able to reach the required goals.
The Doctor
Precision Content was created to fill the DITA gaps and to help companies recover from DITA-saster before the Daleks come hunting with budget cuts and Microsoft Word solutions.
Precision Content includes a detailed, usable, proven writing standard that can be intelligently modified when needed. Authors have the support they need not only to write consistent content but to write highly usable content—precise and clear for those who need it most.
Precision Content always includes not only tag use standards but also a review strategy so tag use is consistent and enforced. And reviewers too if you need them!
The heavy lifters at Precision Content also turn their sonic screwdrivers to the tools and content strategy. It’s never too late to get back on track and reach (and even identify) the goals that will keep the Daleks at bay.
Whatever your state of DITA adoption, whether you’re in mid-disaster or just starting out, Precision Content is the perfect Dalek-fighting solution.
Enter the team
The Precision Content team works with you and your team to address and fix the damage done and determine the best path forward.
- Writing: They have a team of writers who can write and re-write content and content strategists to help.
- Training: Certified trainers ensure everyone understands the standards and stick around to ensure tag use and writing standards are both adhered to.
- Content Strategists: They have architects to help you identify goals and requirements, then guide you through the process end-to-end tools selection and content strategy.
Don’t let the Daleks EX-TERMIN-ATE your documentation plans. Get back on track with Precision Content. Contact us today.
Photo references:
Dr. Who – pictures.4ever.eu; Before – cakewrecks.com; After – bestweddingcakesidea.com