Content refactoring

Analecta Communications specializes in content refactoring.

Content refactoring is a technology-independent approach to changing the way that content is organized, managed and presented. It allows information developers to specify the data structures and processing systems they need without necessarily having to learn about XML, CMS, databases, or programming.

As writers, we refactor content to better meet the needs of the audience. But we also refactor content to improve the economics of content development and delivery. For example, we sometimes cross-reference commonly used information rather then presenting it in line so as to reduce the number of pages in a book and to reduce the effort of managing duplicate information.

Fundamental constraints

Information development is governed by three fundamental constraints: readers, authors, and media. Any given document is a compromise between what the reader needs, what the media can support, and what the author has the resources to create.

Static refactoring

Static refactoring is about changing the organization of content in a document in order to better balance the fundamental constraints. It may be undertaken to improve the user experience, to reduce the cost of media production, or to reduce the burden on the author. Authors have always practiced static refactoring and every writer is familiar with the basics or refactoring and the tradeoffs it involves.

Dynamic refactoring

Dynamic refactoring is about changing the way that information is created and managed internally so that the author is no longer constrained by working in document structures. By creating content as ordered components that can be automatically assembled to generate documents, authors can gain significant efficiencies, reduce errors, and respond more rapidly to change.

Dynamic refactoring as an extension of the static refactoring. It uses the same fundamental reader and content analysis used in static refactoring. The difference is that in the case of dynamic refactoring the categories and divisions of content that were recognized in static refactoring are recorded and made explicit in dynamic refactoring.

Dynamic refactoring also involves the creation of instructions to explain how the information components created are to be reassembled. These instructions form the basis of a specification and test suite for selecting and implementing a content management system.

How is refactoring different from information modeling?

There are many approaches to managing your content. All of them create a model -- some means of separating and labelling different aspects of your content. Many information modelling techniques take a general approach in which an abstract model of your content is created independent of any specific business need. Information modeling is often presented as a one-time activity. Content refactoring is a pragmatic approach that stresses solving problems that exist now, and keeping the model simple so that, when future needs arise, the content can be refactored again to meet those needs. Refactoring is an ongoing activity that seeks to constantly improve the quality and efficiency of you information development process.

Another difference is the skills and knowledge needed to undertake content refactoring. Content refactoring draws directly on the kinds of analysis that writers have always done when planning and organizing their content. There are no foreign concepts to master and no arcane technical details to grapple with. Content refactoring draws on the skills every writer practices and the knowledge every writer possesses. Content refactoring takes the mystery our of the process and puts the writer firmly in control.

When should content be refactored?

You should refactor your content at the following times:

• Before starting a move to XML. Refactoring your content will provide you a practical model that you can implement with XML. Refactoring will allow you to develop this model without drowning in the details of markup. Refactoring helps you keep your eyes fixed on your business goals rather then on technology.
• Before starting a move to CMS. A Content Management System can help you improve the efficiency and consistency of your information development process. However, You should always take a careful look at your information development processes before implementing a CMS. Content refactoring is an essential part of implementing a new process for content development.
• After a move to XML. Once your move to XML is complete it is time to examine the models you have implemented. Do the models meet your business needs? Are they easy to use, or do writers struggle to create conforming content? Have they reduced redundancy or improve output? Content refactoring allows you to improve your XML system to fully achieve the goals you set for it.
• After a move to CMS. After your CMS is installed and running things usually go pretty well for a while. You cleaned up and organized your content before you put it into the CMS and that really made life easier. Before too long, however, things can start to get messy again and processes can start to slow down. Content refactoring allows you to keep your content collection clean and well organized and running at top efficiency.
• When things change. Information development groups live in a changing world. If they didn't, there would be nothing to write about. The impact that changes have on your content can be dramatic and unpredictable. Refactoring your content allows you to adapt more easily to change and to make your content more resistant to the impacts of change.
• Always. No system is ever perfect. In a competitive world you need to be constantly looking for ways to improve the quality of your products and the efficiency of your processes. Content refactoring is the key to driving improvements in both the quality of the documents you produce and the efficiency of the processes used to create them. These two types of improvement are related because a gain in efficiency frees resources that can be devoted to improving quality. Content refactoring should be a key part of your commitment to continuous improvement.

Analecta Communications can help

Analecta Communications provides training and consulting on content refactoring. Contact Analecta Communications today to begin exploring content refactoring.