If you haven’t done your homework on DITA yet, then it’s way too early to be looking at technology. So if you’re shopping around for solutions – please save yourself some hassles, stop shopping, and read on.
Now that we’ve gotten that out of the way, let’s suggest some things you can do to get off on the good foot.
The transition from unstructured authoring (e.g. desktop publishing) to structured authoring is significant, and the change costs are non-trivial. Before you evaluate technologies, you need to determine if DITA is right for you. Ask yourself:
- Will my organization benefit from content reuse – e.g., do we reuse content between products or different types of publications like training and manuals?
- Do we deliver content in multiple languages?
- Do we deliver content in multiple formats (print, PDF, help, web, mobile, etc.) from a single source?
- Are our documents heavily designed, where every page requires manual layout?
- Do we need fine-grained control over whitespace and text flow in our printed documents?
Unless you answered a strong “Yes” to at least one of the first three questions – and a very strong “No” to each of the last two – DITA is probably not right for you.
If you’ve determined that you can benefit from component content, and that DITA is right for you, there is still learning to do and preparations to make before you can transition from desktop publishing to productively using any DITA solution. Here’s our recommendations for a successful DITA implementation:
- Get familiar with the Need to Change. If you’ve never used structured authoring solutions before, you should take some time to understand the differences in information development methods – and writing styles – for component-oriented content. There are a number of books on the market that lead you through best practices for creating reusable content. We suggest you explore Minimalism and Writing For Reuse as topics of interest to your information developers, and read books and attend learning events like a DITA Boot Camp. JoAnn Hackos talked about using Minimalist Principles in an easyDITA webinar.
- Join communities. We recommend the LinkedIn DITA Awareness Group and The Content Wrangler Community for starters.
- Develop a Content Strategy. This means understanding how content will be reused, localized, managed, and delivered. A complete content strategy will define a workflow that assures content quality and compliance with your requirements. It will validate whether and why you should transition from desktop publishing to DITA, and will outline the Return on Investment. A complete content strategy will also define a transition plan for how to address legacy content, and how and when to convert that content to DITA. There are a number of consultants that specialize in Content Strategies for component content in general, and DITA in specific. Find one to help you develop a content strategy (we can recommend several if you like). Watch a webinar with Sarah O’Keefe on the importance of having a content strategy up front.
- Develop a Content Model. A content model is a “data structure” for document-oriented content. it defines how content will be reused. For DITA projects this means deciding on whether you require a DITA specialization or not, and implementing a “flavor” of DITA that meets your needs. In some cases this means extending DITA, but in just as many it can mean defining the subset of DITA that meets your needs. This is something else a DITA consultant can help you with. For more on this topic, see When do you need a DITA XML consultant, and Why?
- Document your Technology Requirements. Once you have a content strategy and content model, you can develop your essential requirements for authoring, content management, collaboration, and publishing technology. Be sure to make strong distinctions on what is essential and what is “nice to have”. Use these requirements to develop a “short list” of solutions that meet your needs. Take advantage of Free Trial offers (like ours) to validate that products meet your requirements, and get to know the vendors during the trial process.
- Develop an Implementation Timetable and Secure your Budget. Once you have requirements, it’s time to put a plan in place to adopt DITA and a budget to support a Pilot and a Production System Rollout, including training and change management.
- Conduct a “Production Pilot”. Using your content model and choosing a legacy publication or a small “live fire” content project, convert or develop the content in DITA, and reproduce two or more of your output formats. This will give you a practical understanding of what it takes to publish DITA content (i.e., stylesheet and transform development), as well as any limitations on the finished look of your published outputs. You will need a DITA implementation consultant to help you in this process. You’ll also need a production DITA environment for the pilot. easyDITA is well suited for this; you can use easyDITA Lite on a month-to-month agreement during the pilot, with no long term commitment until you prove that DITA will work for your organization.
- Implement DITA. After you’ve completed your pilot and learned about any “gotchas” along the way, you’re ready to buy technology, deploy it, and get your organization up to speed.
We hope that – when you’re ready – easyDITA meets your requirements and proves to be the right solution for your team.
Latest posts by Paul Wlodarczyk (see all)
- How to decide if DITA is right for you – and where to learn more - February 16, 2014
- Task-Oriented Info Dev for Agile Software Development - October 31, 2012
- The trouble with delivering product documentation in wikis – and some better alternatives - July 20, 2012