Skip to content
Content Pro banner

Topic-based Information Development

Posted in Colleagues

Overview

Topic-based, modular information development is a technique, rather than a technology. The change in writing technique from document-centric to topic-based can be a challenge for many technical writers. The biggest challenge when moving to topic-based paradigms such as DITA has proven to be the “major change in the document-centric mindset” required (according to a 2009 survey). The important changes in technical writing practice include the separation of content and form, using modular information units, document assembly, context-neutral writing, map and manifest files, and document assembly.

Changed Mindset

A WritePoint survey in 2009 found that the major challenge for technical writers moving to topic-based information development was the difficulty in changing mindset. Rather than thinking of manuals as single, linear documents, writers need to think of independent, re-usable information modules. To allow greater re-use opportunities, text in the modules must be designed so that the same information can be used in different combinations in different documents. This approach is referred to as “context-agnostic writing”.

While it is desirable to minimise context in topics, it is absolutely vital that presentational information be totally separated from the content itself. This practice of the separation of content and form allows presentational form to be applied automatically during the publishing process, so that the same content can be formatted differently according to the document, Web site or other publication that it is used in.

Allowing topics to be assembled into different deliverable documents even though they may have different presentation formats can dramatically reduce the efficiency of document production. The main area of productivity improvement is in reducing repeated effort, such as writing or copying the same information into different publications, and then having to update the same information many times. There are also enormous savings in localisation when information is effectively re-used.

Linear vs Non-linear
Changes in reading patterns and information acquisition suggests that readers no longer want to read deeply through long, linear texts. Instead, research suggests they want to skim read, and read only the minimum to allow them to perform a task. Topic-based information structures are more appropriate for these impatient readers.

The Big Challenge: Letting Go!
Topic-based information development requires many changes in the document workflow and in the approach that technical writers take. Currently, many technical writers have control of most of the documentation process, including page layout, styling, composition, and production. Authors need to let go of the need to control all parts of the process, and follow a methodology that provides greater efficiency by moving from “crafting” documents to “producing” and “assembling”.

Separation of Content and Form
Fundamental to most topic-based information development is the concept of the separation of content from presentation and delivery. The way a piece of text looks during authoring should be totally irrelevant, if that topic is going to be potentially output to different documents, in different contexts. The formatting and presentation are post-authoring considerations, and activities probably not performed by a technical author.

Minimising Context
One of the challenges of working within a modular, topic-based authoring environment is the imperative to remove context from the writing to enable re-use. The ability to re-use the same content modules is especially important for organisations managing large documentation suites, such as motor vehicle manufacturers producing documents with sizable proportions of common content.

Object Orientiation in Topic-based Information Development
The same fundamental idea behind object-oriented programming is used in topic-based information development. Rather than repeating text, or copying and pasting blocks of content from one place to another, information is structured into chunks that can be re-used multiple times in many different places. In this way, a piece of content is referenced, or transcluded, from its source location to its re-use location.

Document Assembly
Topic-based information is typically developed and managed at the library or repository level, rather than at the document or publication level. Topics are created independently of the publication in which it might be used, to increase the opportunities for the same topic to be re-used in different publications. The process of creating a published document therefore becomes a task of document assembly: choosing the constituent components and then producing that document product through an automated publishing process. The published document might be a book, a PDF, a Web site, or a Help system.

Map or Manifest Files
The topics created in a topic-based information deveopment process are usually stored in a library-level topic repository. When a publication is required, be that a Web site, a Help system, a user guide or a product brochure, the publication is specified through a topic manifest or map file. The map file simply lists the topic files that make up the publication, and specifies a hierarchy and sequence for those topics. Because formatting and styling information is not hard-coded in the topics themselves, the publishing process can apply the necessary form. For example, if a topic is used at a third level in the hierarchy of one publication, it can be automatically given a Heading 3 style when generated as a PDF. If the same topic is used at the second level of a hierarchy in a different publication, it can be generated with a Heading 2 style.

Content Management
As topic repositories grow in size over the life of a documentation project, it will become more and more difficult to find and manage information in the repository. A content management system that allows technical writers to easily search for already written content, to move and rename topics, and to reveal the relationship between documentation objects, becomes an indispensible tool.

The Benefits
Ultimately, a change of approach to writing should only be taken if there are benefits in changing. Moving from document-centric to topic-based, library-centric information development provides significant productivity and efficiency benefits. To maximise the benefits, technical writers need to invest in new skills, new tools, and a new mindset!

Tony Self has worked as a technical communicator for almost 30 years, with the last 20 of those years specifically in the areas of online help systems, computer-based training, and electronic documents. In 1993, Tony founded HyperWrite, a hypertext and technical documentation company based in Melbourne, Australia. The majority of his work involves providing online and Internet strategy advice, innovative solutions and specialised training for customers in Australia and other parts of the world. Tony also lectures in the Technical Communication program at Swinburne University in Melbourne, and holds a Graduate Certificate in Teaching and Learning and a Graduate Diploma in Technical Communication. He is a Fellow of the Institute of Scientific and Technical Communicators (UK), a member of the OASIS DITA Technical Committee.

[author] [author_image timthumb=’on’]http://www.writersua.com/conference/images/spk_asch.jpg[/author_image] [author_info]Tony Self has worked as a technical communicator for almost 30 years, with the last 20 of those years specifically in the areas of online help systems, computer-based training, and electronic documents. In 1993, Tony founded HyperWrite, a hypertext and technical documentation company based in Melbourne, Australia. The majority of his work involves providing online and Internet strategy advice, innovative solutions and specialised training for customers in Australia and other parts of the world. Tony also lectures in the Technical Communication program at Swinburne University in Melbourne, and holds a Graduate Certificate in Teaching and Learning and a Graduate Diploma in Technical Communication. He is a Fellow of the Institute of Scientific and Technical Communicators (UK), a member of the OASIS DITA Technical Committee.[/author_info] [/author]

 

58 Comments

  1. 223893 970848Utterly composed subject material , thanks for selective information . 84185

    03/06/2014
  2. 163052 742483Excellent read, I just passed this onto a colleague who was doing a little research on that. And he actually bought me lunch because I found it for him smile So let me rephrase that. 968259

    03/10/2014
  3. 65368 982650I would like to see much more posts like this!.. Fantastic blog btw! reis Subscribed.. 580589

    03/12/2014
  4. 284886 933112I conceive this web website contains some rattling great info for everyone : D. 500812

    03/12/2014
  5. 921456 284396I enjoy your writing style actually enjoying this internet web site . 409588

    03/18/2014
  6. 121657 354458Its very good as your other content material : D, appreciate it for posting . 417736

    03/19/2014
  7. 942920 381566Can I just now say that of a relief to locate somebody who truly knows what theyre speaking about online. You truly know how to bring a difficulty to light and function out it crucial. The diet want to see this and appreciate this side on the story. I cant believe youre no a lot more popular since you undoubtedly possess the gift. 840009

    03/20/2014
  8. 757419 342123Thank you for your very good information and respond to you. 611025

    03/22/2014
  9. 852364 259717I always was interested in this topic and nonetheless am, regards for posting . 423637

    03/22/2014
  10. 411965 511569Thank you for this fantastic post! It has long been very useful. I wish that you will carry on posting your understanding with us. 137131

    03/25/2014
  11. 615944 916055I like what you guys are up too. Such smart function and reporting! Carry on the superb works guys I?ve incorporated you guys to my blogroll. I feel it will improve the value of my internet web site 876923

    03/30/2014
  12. 352522 96130Any person several opportune pieces, it comes surely, as well as you bring in crave of various the many other types of hikers close to you with hard part your question. pre owned awnings 178049

    04/01/2014
  13. 344905 840688Das beste Webdesign Berlin erhalten Sie bei uns, genauso wie professionelles Webdesign. Denn wir sind die Webdesign Agentur mit pfiff. 401393

    04/01/2014
  14. 887276 976338It shows how you comprehend this topic. Added this page, is for far more. 781922

    04/01/2014
  15. 667383 277162Why didnt I think about this? I hear exactly what youre saying and Im so happy that I came across your blog. You really know what youre talking about, and you made me feel like I should learn more about this. Thanks for this; Im officially a huge fan of your blog 45977

    04/07/2014
  16. 299594 506714Aw, this was a truly nice post. In concept I would like to put in writing like this moreover – taking time and actual effort to make a extremely great article

    04/07/2014
  17. 106200 861130After study a few of the content in your site now, we genuinely such as your technique of blogging. I bookmarked it to my bookmark web site list and will also be checking back soon. Pls check out my web-site likewise and make me aware what you believe. 128048

    04/19/2014
  18. 444125 473259I discovered your weblog web site on google and verify several of your early posts. Continue to preserve up the superb operate. I just extra up your RSS feed to my MSN News Reader. Searching for forward to reading extra from you in a although!

    04/21/2014
  19. 371528 612761How may be the new year going? I hope to read a lot more intriguing posts like last year 795599

    04/21/2014
  20. 76688 730689I got what you intend,bookmarked , quite decent internet site. 301335

    04/25/2014
  21. 161996 92116Thank you for this. Thats all I can say. You most definitely have made this into something thats eye opening and important. You clearly know so much about the subject, youve covered so many bases. Great stuff from this part of the internet. 935182

    04/27/2014
  22. 357404 1494woah i like yur web site. It truly helped me with the info i wus looking for. Appcriciate it, will bookmark. 654515

    04/30/2014
  23. 384482 922703I like this web site so significantly, saved to favorites . 41784

    04/30/2014
  24. 805926 347435Perfectly indited content , thanks for selective information . 958237

    05/02/2014
  25. 608817 884074It is a shame you don

    05/03/2014
  26. 333113 242854Extremely nice design and style and great subject matter, extremely little else we want : D. 177544

    05/04/2014
  27. 383202 381163Thank you a whole lot for sharing this with all folks you truly recognize what you are speaking about! Bookmarked. Please in addition speak more than with my internet web site =). We could have a hyperlink alternate arrangement among us! 358818

    05/06/2014
  28. 476140 966744I admire your function , regards for all of the valuable weblog posts. 607035

    05/09/2014
  29. 927577 567492Does your weblog have a contact page? I

    05/15/2014
  30. 861451 591635The the next occasion I read a weblog, I actually hope so it doesnt disappoint me about brussels. Come on, man, Yes, it was my option to read, but I just thought youd have some thing fascinating to state. All I hear can be plenty of whining about something which you could fix should you werent too busy looking for attention. 563566

    05/22/2014
  31. 231738 451922I think other website proprietors should take this internet site as an example , very clean and fantastic user genial style . 584194

    05/24/2014
  32. 641135 912964You produced some decent points there. I looked on the internet for the concern and identified most individuals will go along with along with your internet site. 836404

    05/25/2014
  33. 553485 314600I really delighted to find this internet site on bing, just what I was searching for : D too saved to fav. 384538

    05/26/2014
  34. 929925 802664I think other website proprietors should take this internet site as an example , very clean and fantastic user genial style . 759361

    05/29/2014
  35. 850477 936797I admire your function , regards for all of the valuable weblog posts. 832098

    06/01/2014
  36. 736753 935037Some genuinely great blog posts on this internet site , regards for contribution. 171957

    06/03/2014
  37. 587379 925395Hey! Do you use Twitter? I

    06/04/2014
  38. 48694 669511I like the way you conduct your posts. Hmm

    06/10/2014
  39. 979558 449831Right after examine a couple of with the weblog posts on your internet web site now, and I actually like your manner of blogging. I bookmarked it to my bookmark site record and will probably be checking back soon. Pls take a appear at my internet page as properly and let me know what you feel. 382479

    06/11/2014
  40. 795320 216623I admire your piece of work, regards for all the interesting posts . 628290

    09/03/2014
  41. 842698 153757I was reading by means of some of your content material on this internet web site and I believe this web site is actually instructive! Maintain putting up. 282934

    09/09/2014
  42. 851112 848559Some times its a pain within the ass to read what individuals wrote but this web site is real user genial ! . 362042

    09/27/2014
  43. 758634 464660Wow post thanks! We feel your articles are wonderful and want far more soon. We really like anything to do with word games/word play. 331374

    09/29/2014
  44. 338616 854983What a lovely blog page. I will certainly be back again. Please keep writing! 645653

    10/25/2014
  45. 340306 67036hi, your site is fantastic. I truly do many thanks for operate 528329

    11/14/2014
  46. 807522 870868Keep in touch whilst functioning from your own home office with out all of the hassle of purchasing or procurment costly office equipment. Debtors are allowed to apply with their a bad credit score background whenever. 154035

    12/03/2014
  47. 194797 750046Flexibility indicates your space ought to get incremented with the improve in number of weblog users. 859697

    12/17/2014
  48. 150804 903657I enjoy this website, will certainly arrive back. Make sure you carry on writing high quality posts. 197857

    01/22/2015

Comments are closed.