The 5 principles of single sourcing in technical documentation. 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. Although it is often confused with the tactic of adjusting paperbased paperwork into online codecs, single sourcing is a writing method that allows technical writers to develop centralized information modules, then map them to distinct audiences and media. Single sourcing building modular documentation by kurt. Although it is often confused with the process of converting paperbased documents into. Documentation for a customized version of software contains a paragraph that does not appear in the documentation for the basic version. Unless otherwise stated, all data in this manual is in littleendian order, with the least significant. When you use single sourcing, all topics can be assembled and published by using the files topics in a single repository. Jan, 2016 the 5 principles of single sourcing in technical documentation. There is a way to singlesource using ms word 2007 and later.
Where source development meets documentation singlesourcing. Mortensons chicago office, which recently built the new 296bed silver cross hospital in new lenox, illinois, and led a joint venture partnership to build the ann and robert h. Building modular documentation, is a valuable reference for those of us who seek to save time, effort, and. You dont need to buy this book as everything you need to know will be. Jan 01, 2002 single sourcing is more than mechanical document conversion. 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. Apr 29, 2008 most books on single sourcing contain advice about planning, managing, and creating modular projects and documentation. Define contract requirements, scope, budgets, timelines, stakeholders, teams, savings, business case details and risk assessments. Modular documentation details created on saturday, 08 september 2007 18. By splitting the document per chapter or section, we avoid extremely long source files and maintain a clear view over the document.
This can be in a different format pdf, chm, html, printed, etc or in the same format but with different content chunks. Tutorial summary addresses the changing face of technology. Users need to add and remove sections of the document to increase the relevance to the potential buyer. Rather than copying and pasting between documents, you can be more efficient since all content authors can choose the required topics from the repository and then assemble and publish the topics as needed. Commercial buildingplans and documentation checklist. Where source development meets documentation by liz fraley may 19, 2005 presentations with only a small amount of custom tools, juniper networks has managed to do convert documents to multiple formats from one initial set of xml source documents and a single publishing workflow using ptcs arbortext editor formerly epic editor and. 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. Download single sourcing building modular documentation pdf book pdf free download link or read online here in pdf. Single sourcing is more than mechanical document conversion. Jun 17, 2003 kurt ament has hit the nail on the head. Capture all requirements for your sourcing plan in central location. Spreading the content over different files is the solution.
Each document in a set of reference manuals contains sections. What theyre all missing is the bridge between theory and practice. The book is an easy read and is chock full of tips and guidelines. How to modularize using microsoft word as a single sourcing. Rather than developing information for a given format, such as a user guide or online help, technical writers develop information modules at the element section. Because of the modular construction of xtendis, the user only sees what he needs. You can easily process any sas output files and build automated process flows which interact with other systems. Scott abel writes kurt ament has hit the nail on the head.
Modular chars are also used to store handle offsets in the object map. Dec 27, 20 doctohelp has a feature that makes it possible to create targets for different audiences managers vs. Using import files for line items and questions presentation. In contrast to single sourcing, multisourcing involves competition between suppliers, and avoids lockin to a single supplier. Single sourcing building modular documentatio by julieta. All books are in clear copy here, and all files are secure so dont worry about it. How to modularize using microsoft word as a single. Chapter 2 building documents and chapter 3 structuring content are of particular value to those seeking to understand the shift in thinking. Apr 09, 2012 sourcing a file is nothing but executing the file, more importantly making the changes of the file applicable in the current shell itself, the shell which we are working in. 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.
Some modules needed to easily be included and excluded. Read online single sourcing building modular documentation pdf book pdf free download link book now. This is something else that i would not be part of and should not. Chapter 4, pages 5373 standards for online communication. Increasingly, however, one paper manual is not enough. Resources for singlesourcing projects singlesourcing. Singlesourcing and small projects techscribe technical. Use features like bookmarks, note taking and highlighting while reading single sourcing.
Building modular documentation is a valuable reference for those of us who seek to save time, effort, and. There are a multitude of possible benefits to incorporating this into a business, at the same time it can have its drawbacks. Although it is often confused with the tactic of adjusting paperbased paperwork into online codecs. I was able to use live linx conditional text for word tool for a time, but for what i needed, it began crashing ms word and my documentation with regularity. Building modular documentation 2003 william andrew publishing, new york, isbn 08155149. The modular documentation reference guide contains the essential information to start writing documentation in a modular way. Legacy nonmodular documentation split into small, meaningless pieces. It can make working with complex documentation much more efficient. Chapter 3, pages 3151 categorizing type of information.
Technologies role the issue of identical content in multiple media has largely been imposed by the limitations of the tools. Dwg is the native and proprietary file format for autocad and a trademark of. To learn more about how a modular guide works, explore the files and directories in this example directory. Strategic sourcing decision making is the scope of this master dissertation. Legacy non modular documentation split into small, meaningless pieces.
Where source development meets documentation single. Single sourcing and reuse in technical documentation is getting more and more widespread these days. Oracle sourcing implementation and administration guide. To optimize modular documentation, follow these guidelines for naming module anchors and files.
Docbook allows you to create documentation variants from the same pool of xml sources by means of profiling. Creating multiple versions of an output singlesourcing. Rather than developing information for a given format, such as a user. Usually, when we execute a command or a script, a new subshell is created and the script is executed in the subshell. Building modular documentation by kurt ament published 2002 by noyes publications heres some good advice for all documentation. What was not aimed at managers was aimed at writers. Where source development meets documentation by liz fraley may 19, 2005 presentations with only a small amount of custom tools, juniper networks has managed to do convert documents to multiple. If youve used microsoft word for more than a few minutes, youve noticed that its documents are not modular in the least. When maintaining a large number of documents for a product, it can be difficult to keep a consistent set of entities if these entities are declared in the document type declarations of individual xml files.
Although it is often confused with the process of converting paperbased. Sourcing a file is nothing but executing the file, more importantly making the changes of the file applicable in the current shell itself, the shell which we are working in. Oct 09, 20 modular documents make it easier to produce these files, but microsoft word is is not modular by nature. Single sourcing building modular documentation by kurt ament. Singlesourcing and small projects techscribe technical writing. Document information netra modular system product notes. For technical writers, single sourcing means modular writing and information mapping. The editors role in creating modular documentation. Because of the modular architecture, the addition of new wavefunctions, algorithms.
Commercial building plans and documentation checklist7119 page 1 ias codes. The modular documentation project source repository modular documentation reference guide. Jan 31, 2011 most content our documentation remains the same. The following table shows some of the advantages that are claimed for single sourcing. Apr 14, 2015 combining singlesourcing and localization of software and documentation multiplies both the benefits and the challenges. Enterprise architect generate documentation include. This paper describes how ditabased documentation was implemented at cedromsni, one of. Strategic sourcing decisions are, for example, makeor buy decisions and supplier selection. The dms xtendis is a standardized platform that can be functional expanded with modules. Preface, pages xiiixv chapter 1 about single sourcing, pages 122 chapter 2 building documents, pages 2345 chapter 3 structuring content, pages 47147 chapter 4 configuring language, pages 149179 chapter 5 leveraging technology, pages 181201. 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. Modular documents make it easier to produce these files, but microsoft word is is not modular by nature. Tutorial summary r addresses the changing face of technology, information design, and the skills required to ensure effective information development r argues that the use of document databases. The following list is intended to be used as guide in preparing the plans and documentation you must submit electronically.
The modular documentation reference guide contains the essential information to start. Singlesourcing and localization linkedin slideshare. How modular healthcare construction reduces time, cost, and waste written by ausco modular article source. Oct 14, 2019 the modular documentation project source repository modular documentation reference guide. Combining singlesourcing and localization of software and documentation multiplies both the benefits and the challenges. Modular documentation technical communication mark. Learn the difference between globali slideshare uses cookies to. Data warehouse documentation in sharepoint overview. Large, homogeneous documents such as entire help files dont lend themselves to single sourcing, unless identical copies are going to be created in different formats e. Publish your content to several different output formats pdf, html, mobile, etc. A collection of modules that have no relationship to one another. A module must make sense and provide value on its own, even when read separately from the other modules.
Pressure is growing to deliver your information online, perhaps on several different user platforms. Strategic sourcing plans made easier with a takeaway outline robi bendorf, c. To deliver highquality modular documentation, we must become. Ament covers the issuesstepbystepthat many others only discuss. Modular design is quickly becoming an engineering household name, as has lean and toyota production systems tps. Single sourcing and reuse in technical documentation is getting more. Apparently, they can put things down while taking a shower. Learn the difference between globali slideshare uses cookies to improve functionality and performance, and to provide you with relevant advertising. Single sourcing an introduction by justin darley 12 january 2003 summary many documentation departments produce detailed and welldesigned paper documentation. Users need to add and remove sections of the document to increase the relevance. What ea does with this type of content, i believe, is to store it as a binary blob in its database and then, when.
The templates included in this manual help ensure this. This sample creates a pdf document with sas ods of every table in the sashelp library and automatically upload each file to a sharepoint document library. Single sourcing is bigger than mechanical doc conversion. Cmdlets4sas wiki data warehouse documentation in sharepoint. All oracle applications documentation is available online html or pdf. The basis of xtendis is made of some powerful server processes for digitally recording and quickly retrieving large numbers of digital documents and files. Doctohelp has a feature that makes it possible to create targets for different audiences managers vs. Single sourcing building modular documentation pdf pdf. Sequence of blocks byte counts source offset for each block. Modular documentation is designed to enable you to deliver content flexibly. A multi sourcing structure generally has the following features.
Everyday low prices and free delivery on eligible orders. How can we ensure uptodate documents without spending much resources. Building modular documentation kindle edition by ament, kurt. Modularizing documentation projects user guide daps 3. To my knowledge there is no way to include the contents of an internal artifact in an rtf template. A multisourcing structure generally has the following features. Rather than copying and pasting between documents, you can be more efficient. 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.