Content Structure

Think for a minute about how you would like to see your writing described by a critic (say for the New York Times): sensible, understandable, logical, resonating, compelling, interesting…topical? Writing content that works for your readers, especially when it covers something technical and complex, doesn’t just happen. It takes some thought and planning to structure it, both to be usable and relevant to the reader, and to be reusable and effective for your organization. Enter: Topic-based writing.

Technical communicators are, and probably always have been, a passionate bunch willing to debate the merits of their favorite points of view with anyone who has access to a keyboard and a connection. And at least as far back as the turn of the century, one of those classic debates has turned on content versus structure. Back then it was “Structure vs. Substance.” It’s also been technical versus writer. You could even argue that it’s about logic versus intuition. Today, we ask the question as our weekly tech comm poll: is compelling content or robust structure more important?

Summer Replay: We aim to produce documentation that is useful to users. That is, we want our users to find the right topics and use them to achieve their goals with the software. I use ten Documentation Usability heuristics, or rules of thumb, to design, evaluate, and course-correct technical content before the ship date. Using these heuristics can help content developers catch most structural errors, and provide insight into the actual user experience with the documentation.

My most technical day of the LavaCon 2012 conference occurred on the final morning when I focused on working with DITA by attending two sessions: “Migrating to DITA: How Automated Conversion Works and Why it Matters” (with Patrick Baker of Stilo International) and “Collaboration and Instantiation: Engineering Content in DITA XML” (with Cheri Mullins, of Mullins Consulting, discussing her work at AMD).

The Father of XML, Jon Bosak, once expressed (way back in 1998) a vision for how XML would be used to achieve media independent publishing. That early vision is finally coming true, but not the way Bosak expected. Let me explain.

Crowell Solutions will be attending the LavaCon Conference 2012 in Portland, ready to show attendees how its RocketSled™ XML editor can make content reuse a reality across the enterprise, because provides XML authoring in MS Word. Rick Schochler, Crowell’s COO took a few moments to answer TechWhirl’s Fast 5 Interview questions and offered an inside look at RocketSled and what’s on the horizon.

FrameMaker is as close to an industry standard tool that we technical communicators have. FrameMaker isn’t for everyone in every circumstance, but absolute cost should be the last factor to consider; value for your money should be the first. I can honestly tell you that I have four different versions of FrameMaker installed on my machine, and I see the value in every upgrade.