Key Concept Archive

Topic Based Writing: Future-Proofing Your Content?

This is what we’ll cover: Topic-Based writing: the basics The nature of a topic Topic morphology: title, short description (optionally) and content The importance of conceptual consistency Topic-Based writing: content creation and management Standing alone versus story telling A theory of content architecture? Relationship to DITA and structured writing Governance…

Tips for writing great documentation

I recently read a great article by Taylor Singletary who’s been writing documentation for customer facing products that almost all of us use: LinkedIn, Twitter, and Slack. If you ask him, he says he works in “developer relations.” He wrote up the list of things he does to create great, usable,…

Life with Guru D: Adopting a DITA Mindset and Converting Others

DITA methodology is often difficult for people to grasp. It does require a complete shift in how you view and author your content. You can’t take a book and shove it over. It doesn’t work like that. You need to deconstruct and then reconstruct in the new architecture. It doesn’t…

Conference notes from: DITA Best Practices BOF lunch at CMS DITA NA 2015

Tracy Baker and I had a full table and intense discussion on the topics on the minds of the people in attendance. Real time issues and ideas for possible solutions. Topics ranged from reuse strategies to getting started to review processes to getting it all done while still doing your day job. Before…

Information Architecture Bottom-Up

The advent of electronic media and particularly the Web has profoundly changed how people seek and use information. Information seeking today is dominated by search, and not by search of individual works, but search of the whole: whole sites, whole doc sets, and, in particular, the whole Web. With search,…

Creating a Documentation Plan

“Proper prior planning prevents poor performance.” Creating a good documentation plan will help you identify what you’re going to do and can be a valuable political document if the project shifts from under you. Docplans are even more important in a world where you have distributed teams and fragmented documents…

Writing Mobile Documentation: Rewrite or Cut

So you’ve just been told to create a mobile version of your product’s help system… Can we revise content written for a large screen to fit on an iPhone screen? Can we cut it? Is there a point at which the two options are effectively the same? In either case,…

Conquering the Mountain of Legacy Data

So you are finally planning that big move over to structured content. Great! You understand the benefits of reuse and what it means for your business. But what do you do about the mountains of legacy content? Pack it all up and bring it with you? Leave it behind hoping…

Arbortext Editor and DITA Basics Workshop

Update: Registration is closed. We have no capacity for walk-ins. In a tough market, you need to stay ahead the pack. The best way to do that is to make sure your skills are in demand. One of the highest demanded skills in the publications arena is Arbortext. We are…