Collaborative Document Editing with svk

Say you have a document that needs to be presented in two languages and you are the translator. While the translation is in progress, someone revises the original master document. This means you now might be working with an outdated paragraph or one no longer present in the master version. This article tries to map this problem to parallel development, which version control systems solve with the branch and merge model. You will also see how svk helps you maintain translated documents easily.

Kao, Chia-liang. O'Reilly and Associates (2004). Articles>Content Management>Collaboration>Writing

Debbie Kennedy on Modular Writing and Reusability

Kennedy's presentation on modular writing and reusability was attended by about 200 people. In her presentation, Debbie explained how to chunk content by first looking at different content types: procedures, processes, facts, principles, and so forth. She also mentions a tool called Content Mapper that writers can use to chunk and reuse information through Microsoft Word.

Kennedy, Debbie. Tech Writer Voices (2007). Articles>Writing>Content Management>Podcasts

How to Keep the Content Coming: Five Tips

Maintaining a steady flow of high-quality content can be a major challenge for any online venue. Shifting priorities, unexpected crises, ebbing resources, and just plain burnout can (and probably will) take its toll on your content plans. These tips can help you prevent or compensate for problems with your supply of fresh online content.

Gahran, Amy. Contentious (2002). Articles>Content Management>Writing

Leveraging Complex Content for the Support Chain  

The support chain is becoming increasingly important as we begin to understand the deep underlying economic trends of the last half-century.

Osnat, Rani. ComTech Services (2001). Articles>Content Management>Technical Writing

Meaningful Microcontent

Microcontent refers to small, granular, and possibly representative (that can provide a summary of or a navigation to a larger set of information) bits of information, typically available on the Web. An example in the domain of journalism might be headlines and news summaries, small bits of content that can be used on a front page of the news with links to more in-depth articles. The definition has grown in scope as much as in its application.

Albing, Bill. KeyContent.org (2006). Articles>Documentation>Content Management>Technical Writing

Moving to Modular Documents  

Lam’s software-controlled robotic etchers demanded multi-disciplinary manuals that were time-consuming to write. Since both software and hardware changes required a six-month re-write, manuals lagged behind product. Dividing manuals structurally into modular books enabled separate updates, as most urgently required. Modular engineering approaches to ongoing etcher development later drove a different modular design; but the approach enabled quick documentation of rapidly changing product. Company growth and product proliferation now combine with computer technologies to drive development of increasingly smaller modules of information, leading to a database model for books that may someday match individual machines.

Snavely, Deborah. STC Proceedings (1996). Articles>Content Management>Writing

Single Sourcing in Technical Communication

No term has caused such a sensation in recent years among technical writers and illustrators as 'Single Sourcing.' The reasons: Enormous amounts of text and image material builds up in documentation and illustration companies. It is not uncommon for individual documents to contain several thousands of pages. If this is translated into several languages, then the administration needs are greater for both texts and graphics (graphics can contain text which must also be translated).

Fibinger, Iris. SVG Open (2002). Articles>Content Management>Single Sourcing>Technical Writing

Structured Content: What's in it for Writers?

Everyone has heard (or experienced) stories of CMS or knowledge management initiatives that did not work because content contributors refused to use the tools deployed or were unwilling or unable to supply content in the format required. The conclusion often reached is that writers cannot give up their WYSIWYG tools and that any attempt to make them do so is doomed to failure. On the other hand there are always those who will reply with stories of systems where writers have successfully adapted to the use of XML or SGML, and the CMS is working well. All that is required to duplicate this success, they maintain, is that writers must be forced and/or trained to use the new tools.

Baker, Mark. CMSwatch (2002). Articles>Content Management>Single Sourcing>Writing

Time for Content to Become More Scientific

I'm all for formulaic writing. I love hierarchies and classification. I'm all for measuring content. There is a 'right' way to write content. Sure, it may not be the 'perfect' way, it may not be the way Shakespeare or Joyce would have written it, but it'll do. It'll get results and deliver value. A production line can be set up where this content can be mass produced, tested, and measured.

McGovern, Gerry. User Interface Engineering (2007). Articles>Content Management>Writing>Professionalism

Using a Wiki to Write About Wikis  

Academic writers are used to having their ideas encapsulated and enshrined in printed text (e.g., a journal article or a book), but publishing them in a wiki strips them of this protection. What happens when strangers change our writing? Since the traditional academic publishing paradigm has not caught up with the open-editing, peer-to-peer model, are we equipped to deal with the paradigm shift that wikis represent? These are issues we consider in this short piece.

Wilder, Hilary and Sharmila Pixy Ferris. Journal of Electronic Publishing (2007). Articles>Writing>Content Management>Wikis

A Writer's Guide to XML Content Management  

A discussion of how XML changes what you do as a writer.

Hackos, JoAnn T. and Tina Hedlund. ComTech Services (2000). Articles>Content Management>XML>Writing