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

The Why and How of Content Convergence and Integration

Content producers are about to live through interesting times, to adapt the popular saying, with the dawning of The Age of Content. Industry is discovering content as a commodity; the rules are changing, and fast. What have traditionally been seen as the lowliest form of commercial content within an enterprise, technical manuals, are starting to take their place alongside the other valued corporate assets.

Bailie, Rahel Anne. Writing Assistance (2007). Articles>Content Management>Documentation>Technical Writing

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

XML Authoring: Coming to a Desktop Near You

XML for use in technical publications is growing in popularity. As the author explains, technical writers are likely to become more and more involved in XML document production in the future. This article looks at the many benefits of XML authoring and the trend that's moving technical publications toward structured content.

Abel, Scott. Writing Assistance (2007). Articles>Content Management>XML>Technical Writing

Content is King

Are you getting hung up with the XML and all of the other Content Management goodies and forgetting about the CONTENT?

Great Technical Writing (2008). Articles>Writing>Technical Writing>Content Management

The Discipline of Content Strategy

We, the people who make websites, have been talking for fifteen years about user experience, information architecture, content management systems, coding, metadata, visual design, user research, and all the other disciplines that facilitate our users’ abilities to find and consume content. Weirdly, though, we haven’t been talking about the meat of the matter. We haven’t been talking about the content itself.

Halvorson, Kristina. List Apart, A (2008). Articles>Content Management>Content Strategy>Writing

Content-tious Strategy

It’s an open secret in our daily work how often the challenges posed by content elude our collective talents and acumen. We’ve all been there. For me, lorem ipsum makes it personal. It personifies the proposition at the heart of what content specialists do and mocks how often the manifold complexities of content can get the better of all of us. It’s happening because we haven’t been talking.

Macintyre, Jeffrey. List Apart, A (2008). Articles>Content Management>Writing

Advantages of Using Microsoft SourceSafe While Writing Your Technical Documents

Microsoft’s Visual SourceSafe was not created with technical communicators in mind. It was created for engineers writing software source code. But it is successfully used by technical writers in offices around the world to control documentation.

Technical Communication Center (2009). Articles>Content Management>Documentation>Technical Writing

Five Steps to Going Viral on Twitter

Twitter is changing the way information spreads online. Links that would have been blogged a couple of years ago are now more often shared via the micro-blogging service instead, which fundamentally changes strategy when trying to get content to spread.

Zarrella, Dan. Copyblogger (2008). Articles>Content Management>Writing>Social Networking

XML and Office 2.0

Recently there has been a flurry of activity around a concept called “Office 2.0” – another offshoot of the term “Web 2.0” – in which all traditional office applications can be replaced by online services accessible through a generic web browser.

Severson, Eric. Flatirons Solutions (2008). Articles>Content Management>Writing

Write for Reuse

Users often see online content out of context and read it with different goals than you envisioned. While you can't predict all such goals, you can plan for multiple uses of your text.

Nielsen, Jakob. Alertbox (2009). Articles>Content Management>Writing>Information Design

The Many Faces of Content Management: A Primer

None of the technologies mentioned so far support the production of content for purposes of producing technical documentation. Such a system is a specific type of content management that has specialized functions for technical communicators doing multi-channel publishing, yet it hasn't spun off its own specific acronym.

Bailie, Rahel Anne. STC San Diego (2006). Articles>Content Management>Documentation>Technical Writing

Be Known For Your Content, Not Your Name!

Be known for your content first, for your name second. I can’t bear to hear anyone say one more time that “content is king,” but the truth is simple, if painful.

Content Strategy Noob (2009). Articles>Content Management>Web Design>Writing

さまざまな利用を想定して書く

オンラインコンテンツは、文脈とは無関係にユーザーの目にとまることが多い。本来想定された目的とは違う目的で読まれることもよくある。そうした目的を全部予測することはできないが、テキストのさまざまな利用を考慮することはできる。

Nielsen, Jakob. Usability.gr.jp (2009). (Japanese) Articles>Content Management>Writing>Information Design

Content Curation: A Manifesto

A Content Curator is someone who continually finds, groups, organizes and shares the best and most relevant content on a specific issue online. I think that professional writers and technical writers should consider a move towards this role. We already search for and find the best content, sift through loads of content, discard poor content, and publish the most worthy content whenever a software release goes out. This description also sounds like something a content strategist would do as part of their analysis of the content.

Gentle, Anne. Just Write Click (2009). Articles>Content Management>Information Design>Technical Writing

Change Management – An Underestimated Success Factor 

Although the creation and translation of technical documents are essential parts of the product lifecycle they still play a subordinate role in most international organizations. Many companies are therefore leaving these tasks to an outsourcing provider. To ensure a smooth collaboration and guarantee high quality technical documents, the outsourcing process needs to be planned and supported thoroughly.

Grosser, Sabine and Rob Heemels. TC World (2008). Articles>Content Management>Outsourcing>Technical Writing