Key Concept Archive

Writing (Non-Agile) Business Requirements

Writing requirements requires the ability to write clearly, concisely, and succinctly so others can design, develop, and test the product. This session covers 8 characteristics of writing a good requirement, reviews 4 steps to requirements gathering, and concludes with 17 tips for writing good requirements. Come and learn how to…

Collaboration – Love it or Hate it?

This month I wanted to find out if you have come to love or hate collaboration in any of it’s forms.  I’m a big experimenter which often means I’m a big collaborator. In January’s TC Dojo, we had Karl Klashinsky do a session on Git, the open source software version…

What You Need to Know about Agile and Tech Comm

When working in an agile environment, technical writers can face some challenges in planning, workload balancing, and execution. But writers can realize numerous benefits in this environment if they follow a few principles to stay flexible and fully engaged on their project teams. This session provides the top five things…

Best Practices for Arbortext Workspaces in Windchill

Using workspaces in Arbortext Content Manager (or Windchill) can be a bit confusing. How do you keep it clean? When should you create one? How long should you keep a workspace? How do you know which one to us (if you have several)? And, hey, while we’re at it, why…

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…

Collaborative Writing in Distributed Teams

This session had a lot of votes, so we found John Hedtke, Master of Remote Collaboration, and found a time when he can come talk John’s last book was written with a co-author on the other side of the country that he’s seen exactly twice, but he’s always worked with…

How do authors find content for reuse?

Your customers can find content, but can your content creation team? DITA content explodes. How do you manage it? A lot of customers have been asking us recently about how they’re going to manage content that explodes into lots and lots of little topics and content fragments. Authors wonder if…

Common Questions: Workflow

This week’s topic: Workflow Here are some highlights of Workflow features supported in Windchill: Arbortext Content Manager supports standard workflows as well as sophisticated capabilities for routing change information to the correct process participants. Arbortext Content Manager provides tools to support the creation of processes that are unique or dictated…

Technology, People, and Successful Projects

I was reminded recently of Rebekka Anderson’s presentation at DITA North America a couple of years ago. Her conclusions mirrored what we see every day: Technology is only 1/3 of the things that you need to consider when looking to solve and implement something like dynamic publishing or DITA successfully….

Common Questions: Change Markup

This week’s topic: Change Tracking & Change Markup Change markup has historically been something that you had to implement yourself in XML publishing. Arbortext supports typical change markup behavior in the standard document types, and with a small amount of configuration for custom doctypes. All of the standard change markup…