Single sourcing is more than mechanical document conversion. The modular documentation reference guide contains the essential information to start. Jun 17, 2003 kurt ament has hit the nail on the head. Although it is often confused with the process of converting paperbased. Single sourcing is a contentmanagement method in which one source of content is used. You dont need to buy this book as everything you need to know will be documented on the wiki, but if you are interested in knowing more about single sourcing and modular documentation then this is the book to read. Each document in a set of reference manuals contains sections. Swapnil ogale makes a case for singlesourcing and explains how it can empower his. For a single sourcing project to be successful, the way you define the line between the it team and the functional team the tools team becomes important.
It includes a conceptual overview of single sourcing, a 10step process for transforming linear documents into modular documents, and detailed writing guidelines. Provides an introduction to the benefits of single sourcing summarises the obstacles to successfully completing a single source project outlines some single sourcing strategies and writing techniques introduces some single sourcing tools and technologies. When you use single sourcing, all topics can be assembled and published by using the files topics in a single repository. Dita is a good choice for single sourcing documents. Single sourcing building modular documentation pdf pdf.
Jan 01, 2002 single sourcing is more than mechanical document conversion. However, one of the benefits of modular documentation is that you do not need to worry about how the assembly will ultimately be used each assembly represents a user goal, and once you create it, it can be included anywhere it is needed a publication, within another assembly, and so on. Each document in a set of reference manuals contains sections with the same content. Systems that use dita for single sourcing maintain content in individual topic files. However, one of the benefits of modular documentation is that you do not need to worry about how the assembly will ultimately be used each assembly represents a user goal, and once you create it, it can. Building modular documentation 2003 william andrew publishing, new york, isbn 08155149. Writers of software documentation did not simply move from being writers of traditional. Building modular documentation is a valuable reference for those of us who seek to save time, effort, and money by implementing a productive method of creating information once and reusing it often. If you do find yourself interested, you find more information on the web and in various publications about single source authoring. It includes a conceptual overview of the single sourcing method, a 10step process for transforming linear documents into modular documents, and detailed writing guidelines. List of arbortext users on twitter singlesourcing solutions keeps track of arbortext twitterers.
Introduction to the darwin information typing architecture article. Single sourcing building modular documentation by kurt ament. For more information cherryleaf ltd cherryleaf house 31 arlington road. A gradual approach to single sourcing stc washington, dc. It explains how to transform linear documents into modules, tagging modules for inclusion in different documents for selected audiences, structuring primary and secondary modules within documents. A shout out and thank you to madcap software for creating a tool that lets us quickly and easily. There is a way to singlesource using ms word 2007 and later. The metropolitan region of nuremberg provides the best logistic conditions. Explain captures application screens or web pages and.
Bibliography ament, kurt single sourcing building modular documentation, william andrew publishing, 2003. This is the only book for technical writers that shows how to construct a publication using single source modular documentation software technology. It can make working with complex documentation much more efficient. The modular documentation reference guide contains the essential information to start writing documentation in a modular way. A shout out and thank you to madcap software for creating a tool that lets us quickly and easily repackage existing content into a covid19 toolkit. Kurt ament single sourcing is more than mechanical document conversion. Single sourcing building modular documentation by kurt. Singlesource publishing, also known as singlesourcing publishing, is a content management. The 5 principles of single sourcing in technical documentation.
Get single sourcing building modular documentation pdf file for free from our online library pdf file. Likewise, functional tools teams who support engineering products can also do proactive software development. How to modularize using microsoft word as a single sourcing. The functionality and the singlesourcing possibilities of a modern.
Learn about a new approach to modular documentation based on user stories, and. Chapter 1 about single sourcing introduces the concepts of single sourcing including the reasons, benefits, types, and what makes single sourcing successful. Modularizing documents and singlesourcing using ms word hannah kirk. Building modular documentation, is a valuable reference for those of us who seek to save time, effort, and money by implementing a productive method of creating information once and reusing it often. Building modular documentation by kurt ament published 2002 by noyes publications heres some good advice for all documentation. Although it is often confused with the process of converting paperbased documents into online formats, single sourcing is a writing strategy that enables technical writers to develop centralized information modules, then map them to distinct audiences and media.
Read online now single sourcing building modular documentation ebook pdf at our library. Nov 15, 2005 likewise, functional tools teams who support engineering products can also do proactive software development. Singlesourcing is a software project not a documentation. Mar 01, 2016 report sul libro di kurt ament, single sourcing. Ive had to trust that eventually i will have the opportunity to refactor every part of our documentation set. Using this method, one can develop modular content in one source document or database, and then assemble the content into different document formats for different audiences and purposes. To deliver highquality modular documentation, we must become experts in the information model that drives the modular documentation and become leaders in implementing or delivering on that model 5, 7, and 10.
Single source publishing, also known as single sourcing publishing, is a content management method which allows the same source content to be used across different forms of media and more than one time. For a singlesourcing project to be successful, the way you define the line. Building modular documentation provides a clear and concise introduction to building modular documentation. And, while this chapter is certainly not about selecting software tools, the author helps his readers understand some of the issues they will need to. Eclipsert day austinsession abstracts eclipsepedia. Provided the modules are used as building blocks for userstory assemblies, the individual user.
As long as there is continual gradual improvement kaizen i can feel like im doing. How to modularize using microsoft word as a single. If you are using your documents as a single source to publish different deliverables, or want to leave your options open to do so, you need to read this book. Single sourcing john hawkins systems documentation, inc. Building expertise in single sourcing wsingle sourcing builds marketable skills.
The flexibility of this medium sized company can be seen from the variety of services it offers, for example an advisory service in application technology, disposal and recycling concepts, transfusing, mixing, warehouse management, international productspecific transport or single sourcing. Ament covers the issuesstepbystepthat many others only discuss. Singlesourcing and small projects technical writing. Building modular documentation, william andrew publishing technical writing series, usa, 2003.
This article introduces a lightweight approach to documentation modularity. Using this method, one can develop modular content in one source document or database. With this method, you develop modular content in one source document or database, then assemble the content into different document formats for different audiences and purposes. The flexibility of this medium sized company can be seen from the variety of services it offers, for example an advisory service in. Single sourcing an introduction by justin darley 12 january 2003 summary many documentation departments produce detailed and welldesigned paper documentation. Building modular documentation, is a valuable reference for those of us who seek to save time, effort, and. Although it is often confused with the process of converting paperbased documents into online. Flexible online documentation tool for mac, windows, linux. You dont need to buy this book as everything you need to know will be. The singlesourcing triangle singlesourcing solutions.
Jan, 2016 single sourcing and reuse in technical documentation is getting more and more widespread these days. Singlesourcing allows you to build on the concept of create once. The editors role in creating modular documentation. The following table shows some of the advantages that are claimed for single sourcing. Each topic file describes a single topic, concept, reference, or task. Clickhelp online documentation tool for mac, windows and linux. These templates are in the modular documentation project source.
In many ways, this depends on the charter it has in your enterprise. Single sourcing is a documentation method that allows reusing the information developed. I work for a company that serves large building service contractors who are uniquely impacted by covid19. Attendees will learn about the benefits of single sourcing. In this talk well explore the differences between rap and rcp that are especially relevant to the goal of single sourcing as much code as possible. Writing documentation in modules that can be combined and reused has been around, in various incarnations, for many years, and it has many proponents as well as detractors. Although its primary goal is to save time and money, single sourcing improves the quality of your documentation. William andrew publishing technical writing series. To get you started, i recommend kurt aments very comprehensive book. Documentation for a customized version of software contains a paragraph that does not appear in the documentation for the basic version. Single sourcing and reuse in technical documentation is getting more and more widespread these days. Archives and notes from users and experts about what they have done with arbortext. Building modular documentation by kurt ament this is one of the only books that attempts to bridge the gap between the singlesourcing theorists and the technology developers. Apr 06, 2017 archives and notes from users and experts about what they have done with arbortext.
Editors play a critical role in creating readable and usable modular documentation. Modular building software jobscope erp software a perfect fit for modular building manufacturer the mcavoy group is northern irelands largest portable building manufacturer with a customer base. I needed to modularize documents chunks, assemble modules in varying orders across multiple documents. The modular documentation project source repository modular documentation reference guide. I was recently investigating options for single sourcing when i came across kurt aments book single sourcing. While moving to dita might not improve the quality of your documentation, it can streamline the process of creating and managing those documents. Search for library items search for lists search for. This is the only book for technical writers that shows how to. Singlesource publishing, also known as singlesourcing publishing, is a content management method which allows the same source content to be used across different forms of media and more than one. For example, johnston remembers reading a book, single sourcing. Search and read drone building document opinions or describe your own experience.
Hackos, rockley, ament are, to a significant extent, the existing authorities in theoretical singlesourcing and information design. Pdf editing modular documentation some best practices. The laborintensive and expensive work of editing need only be carried out once, on only one document. Singlesourcing solutions donates time, resources, and administrative support. In the documentation field, new forms of structured writing approaches emerged, enabled by xml. Building modular documentation by kurt ament this is one of the only books that attempts to bridge the gap between the singlesourcing theorists and the technology. Building modular documentation is a valuable reference for those of us who seek to save time, effort, and money by implementing a productive method of creating. Building modular documentation by kurt ament this is one of the only books that attempts to bridge the gap between the single sourcing theorists and the technology developers. Docbook or dita for technical writing what is the difference in. Singlesourcing and small projects techscribe technical. Technical writing software leading tool for tech writers. And, while this chapter is certainly not about selecting software tools. Building modular documentation book online at best prices in india on.
This guide explains in plain language and by example how to build modular documentation you can reuse in different formats for different audiences and purposes. Flare is a good option for single sourcing documentation and particularly print documentation. Software tools for technical writing kesi parker medium. Madcap flare is useful for enterprise companies that need to comply with regulations to produce large amounts of documentation, and companies that have dedicated technical writers who can be trained to use the software. Hackos, rockley, ament are, to a significant extent, the existing authorities in theoretical single sourcing and information design. If youre looking for a free download links of single sourcing. This book explains in plain language and by example how to build modular documentation you can reuse in different formats for different audiences and purposes.
1222 623 629 1649 589 1644 61 861 1129 326 1544 1072 73 1141 591 1278 1432 1272 967 42 1561 996 1656 865 1536 583 727 909 307 576 364 614 799 1373 547 584 433 704 1318 705 115 532