Content Management Systems and DITA (Part I)

Content Management is imperative as technical writers are required to produce more documentation more efficiently. How can DITA and Content Management Systems help?

Alex Masycheff  of WritePoint gave an overview of what seems to be the newest buzzword in Technical Writing: DITA, and why it is growing in popularity for Content Management.

The average technical writer is being asked to be even more productive and efficient. What are our challenges?

  • Multiple products are coming out of the same company at the same time
  • Multiple types of documents are needed for these products
  • The deliverables for one product may be in a number of different formats
  • The same product may be sent to different markets requireing soemwhat different documentation
  • Translation of our documentation is becoming the norm as we meet internationalization requirements

How can we provide all of the above and yet maintain quality and consistency?

DITA, which stands for Darwin Information Typing Architecture, is being touted as the answer to all of the above. DITA, which is XML based, is the defined framework for structure. The basic building block of this structure is the "topic." The topic focuses on a single subject, which is stored as a single file in DITA. Since the topic is the basic building block, it can be used as a child would blocks: each block can be reused, mixed and matched, and pulled out to build different structures or documents. Topics require a different way of writing, though. A topic is not linear but is specific for type:

  • Concept: what is it
  • Task: how to do it
  • Reference: a piece of information (used in API or in writing a White Paper)

Without DITA, it is possible to make documentation fit more than one role. Conditional text, variables, inserts, and in FrameMaker,  books can be used. When the possible variations are small, it can be manageable. When working for a large company, with many different products and documentation possibilities, content management becomes imperative.

How does DITA work? Topics are kept in a single repository; each topic is a file. Topics are then chosen and strung together to make the deliverables. The same topic can appear in many products and can be used in different document types, assembled using a DITA map.

What are the benifits using DITA with a Content Management system?

  • Improves content reusability
  • Not dependent on tools such as conditional text
  • Single sourcing
  • Automation
  • Version control
  • Can be a collaboration process with different writers
  • Can be consistent with specific style sheets used by all writers

DITA does, however, require a a content management system to be able to search retrieve the necessary topics as needed, as well as a mind-set change from writing whole documents to writing individual topics.

 

Useful Information

  • Job Listings (visible to only members)

  • Employee Benefits

  • Other Sites and Resources

    Survey Reporting

    Q2 2010 Survey Results

    Requires access rights

    Employee Salaries (18 pp)

    Freelance Writer Rates (11 pp)

    Q4/09 Copy Editor Rates (9 pp)


    Columns on Elephant

    Translatable but Debatable

    Each month, Mark L. Levinson presents one hard-to-translate Hebrew word at a time for discussion.

    Of Mice and Keyboard Shortcuts

    Michael Cohen will teach us practical shortcuts that save us time and make our lives easier.

    The Why of Style

    Mark L. Levinson examines the big and little factors that make writing effective.

    Broken Bell Education in Israel

    David Siegel looks at the problems in education in Israel and discusses what can be done.

    Jonathan's Tool Bar & Grill

    Jonathan Plutchok identifies free or inexpensive utilities or plug-ins that save time, increase productivity, improve your computing environment, perform a task you otherwise couldn't do... or is just too much fun to ignore. This column has grown into its own blog at http://jonathanstoolbar.blogspot.com where you can find new issues every week.

    It's in The Script

    Paul Schnall teaches us about the power of FrameScript and how to use it.

    Do it Yourself

    Did you ever wonder what was inside a PC, laptop, or other microcomputer system? Michael Cohen teaches us what's inside and how to configure and build our own.

    Coaching for Success

    Dr. Tal discusses the principles of professional coaching, focusing on resiliency.

    Hunters and Gatherers

    Eric Gluch looks at modern marketing.

    Moving to Chelm

    Esther Shira Stepansky takes us on a humorous adventure in the modern day land of Chelm as we look at some of the challenges of making aliyah and finding work in Israel. Making aliyah is supposed to be the fulfillment of my of your Jewish identity, so why does Israel make it so difficult?

    Why am I a Tech Writer?

    By Michael Altman

    Life as a Tech Writer

    By Mumpy

    Building Bridges (in Hebrew)

    Dr. Zaidel discusses another aspect of mediation within the framework of Israel's court-approved Alternative Dispute Resolution (ADR) process.

    Don't Forget

    Hezy Asher teaches us how to improve our memory.

    World of Podcasting

    Tom Johnson's podcast episodes, provide tips on recording presentations, and other podcasting related news and events.

    Effective Management ניהול אפקטיבי

    By Eitan Reuveni

    Scribblin' With Steph

    By Stephanie Freid

    Life in Northern Israel

    By multiple authors

    Life on the Southern Front of Israel

    By Israel Ivri

    Event Summaries

    Summaries of events held by Elephant and other organizations throughout the Israeli technical/marcom community.