Process Re-engineering for Topic Based Authoring

Presented at STC Summit in Atlanta, GA in May 2009. Presented at Spectrum 2008 in Rochester, NY by Rob Hanna. Discussion of the implied changes moving to a topic-based writing system from a book-based paradigm.
of 28
All materials on our website are shared by users. If you have any questions about copyright issues, please report us to resolve them. We are always happy to assist you.
Related Documents
  • 1. Process Re-engineering for Topic-Based Authoring Rob Hanna Content Management Consultant ASCan Enterprises
  • 2. What is Topic-Based Authoring? <ul><li>“ Topic-based authoring is a modular content creation approach…” </li></ul><ul><li>“ A topic is a discrete piece of content that is about a specific subject, has an identifiable purpose, and can stand alone…” </li></ul><ul><li>http://en. wikipedia .org/wiki/Topic-based_authoring </li></ul>
  • 3. Opportunities for Topic-Based Authoring <ul><li>Speed to market </li></ul><ul><li>Reduced maintenance effort </li></ul><ul><li>Better opportunities for reuse </li></ul><ul><li>Balancing workload </li></ul><ul><li>Finer control for project management </li></ul><ul><li>Opportunities for collaboration </li></ul><ul><li>Clearer, more concise content </li></ul>
  • 4. Challenges for Topic-Based Authoring <ul><li>Writing process requires greater discipline </li></ul><ul><li>Loss of content ownership for authors </li></ul><ul><li>Less control over look and feel </li></ul><ul><li>Responsibilities redefined </li></ul><ul><li>Loss of context for SMEs and authors </li></ul><ul><li>More to manage </li></ul>
  • 5. Topic-Based vs. Book-Based <ul><li>Topic-Based Authoring </li></ul><ul><li>Multiple authors per book </li></ul><ul><li>Topics serve multiple products and audiences </li></ul><ul><li>Content is iterative </li></ul><ul><li>Presentation layout can be template-driven </li></ul><ul><li>Well suited for modular hardware/software products with short lifecycle or long life span. </li></ul><ul><li>Book-Based Authoring </li></ul><ul><li>One author per book </li></ul><ul><li>Books serve a single product and audience </li></ul><ul><li>Content is linear </li></ul><ul><li>Presentation layout requires manual work </li></ul><ul><li>Well suited for highly technical or one-of-a-kind products with a long development cycle and/or short life span. </li></ul>
  • 6. Single-Sourcing <ul><li>Single-sourcing is not about content reuse - it is about reusable content. </li></ul>
  • 7. Single-Source Authoring <ul><li>Single-source practices should be followed regardless of topic- or book-based approach. </li></ul><ul><li>Single-sourcing is all about maintaining a single, definitive source of content. Reuse is merely a benefit of single-sourcing. </li></ul><ul><li>Book-based authoring is used where content can generally only be reused in situations where reuse is planned. </li></ul><ul><li>Topic-based authoring makes it much easier to reuse content without anticipating its specific reuse context. </li></ul>
  • 8. Topic-Based Architecture <ul><li>Topics are standardized units of information based upon information type </li></ul><ul><li>Topics require only navigational reference for context and can be read in any order </li></ul><ul><li>Topics must all contain a descriptive title and normally include a body and metadata section </li></ul><ul><li>Topics represent a single unit of work for authors </li></ul><ul><li>Topics may contain other topics where there is an inseparable relationship from parent to child </li></ul>
  • 9. Information Typing <ul><li>Information types separate content into easily identifiable chunks of information </li></ul><ul><ul><li>DITA identifies 3 specialized topic types </li></ul></ul><ul><ul><li>Information Mapping ® identifies 7 information types </li></ul></ul><ul><ul><li>Information Management Model TM identifies 11 information types </li></ul></ul><ul><ul><li>S1000D identifies 22 common data modules </li></ul></ul><ul><ul><li>Mil Spec 2361 identifies 55 work packages </li></ul></ul>
  • 10. Topic-based authoring changes how content is managed <ul><li>The number of files your team will be working with will increase dramatically </li></ul><ul><li>Over time it will be more difficult to identify and track these files </li></ul><ul><li>You may be required to track successive versions of files </li></ul><ul><li>To manage your files effectively, you will need to introduce and manage metadata </li></ul>
  • 11. Storage Conventions <ul><li>Topics must be stored in a centralized repository or network drive </li></ul><ul><li>Your authors have gotten used to browsing for files and using folders and file names to manage them </li></ul><ul><li>Folders and file names will not be enough to track files – track them through an index </li></ul><ul><li>If free from file browsing, you can introduce much flatter directory structures and more meaningful file names </li></ul>
  • 12. File Naming Conventions <ul><li>Tracking files by topic title will breakdown over time </li></ul><ul><li>To effectively track topics, you need to introduce a fixed-length global unique identifier (GUID) for file names </li></ul><ul><li>GUIDs should include metadata attributes to help identify the files. Do not include version-specific attributes </li></ul><ul><li>GUIDs can be appended by a short descriptive text for ease of reference </li></ul><ul><li>For example: xxx-yyyy-00001-descriptor.dita where: xxx = information type, yyyy = scope, and 00001 = sequence of topic. </li></ul>
  • 13. Use of Titles <ul><li>Concise titles are crucial to the effective management of topics. </li></ul><ul><li>Titles should never include markup or special characters of any sort. </li></ul><ul><li>Alternate title markup allows you to create one title for publishing and another for navigation. </li></ul><ul><li>Consider all titles including sub-titles, figure titles, and table titles. </li></ul>
  • 14. Content Aggregation <ul><li>Unlike book-based authoring that flows from an outline, topic-based authoring can start with content and be organized into a map. </li></ul><ul><li>Maps can be query-based allowing for the automatic aggregation of content. </li></ul><ul><li>Most often maps are built by hand. </li></ul><ul><li>Using DITA, maps and map parts can be used in other maps. </li></ul>
  • 15. Release Management <ul><li>Managing versions of topics is complicated by the fact that they may change more frequently than the documents in which they are contained </li></ul><ul><li>Three major considerations affecting how content is controlled and released: </li></ul><ul><ul><li>Freezing development of topics for approval </li></ul></ul><ul><ul><li>Combining different versions of components into separate deliverables </li></ul></ul><ul><ul><li>Concurrent development of product </li></ul></ul>
  • 16. How does topic-based authoring change how we work?
  • 17. Typical Document Workflow Kick Off Book Planning Book Plan Review Approved Authoring Approved Publish Book Review Yes Yes No No Book Workflow Roles Manager Author Various Groups
  • 18. Roles in Topic-Based Authoring <ul><li>Manager </li></ul><ul><li>Librarian </li></ul><ul><li>Architect </li></ul><ul><li>Author </li></ul><ul><li>Editor </li></ul><ul><li>Subject Matter Expert (SME) </li></ul>
  • 19. Topic-Based Workflow <ul><li>Separate workflow into two independent iterative cycles: </li></ul><ul><ul><li>Book-level workflow </li></ul></ul><ul><ul><li>Topic-level workflow </li></ul></ul>
  • 20. Topic-Based Workflow Kick Off Book Planning Book Plan Review Approved Authoring Approved Publish Book Review Yes Yes No No Book Draft Topic Editorial Review Approved Approved Ready Technical Review Yes Yes No No A A Workflow Roles Manager Architect Editor Author Subject Matter Expert
  • 21. Content Reviews <ul><li>Topic-Level Reviews </li></ul><ul><ul><li>Peer Edit/Review </li></ul></ul><ul><ul><li>Structural Review </li></ul></ul><ul><ul><li>Technical Review </li></ul></ul><ul><li>Book-Level Review </li></ul><ul><ul><li>Sign-off/Approval </li></ul></ul>
  • 22. Working with Subject Matter Experts <ul><li>Gathering Materials </li></ul><ul><li>SME Review </li></ul><ul><li>Traceability </li></ul>
  • 23. Tools needed for Topic-Based Authoring <ul><li>Start with tools you already have: </li></ul><ul><ul><li>Email applications </li></ul></ul><ul><ul><li>Structured authoring editors </li></ul></ul><ul><ul><li>Web servers </li></ul></ul><ul><ul><li>Spreadsheets and databases </li></ul></ul><ul><ul><li>Code management tools </li></ul></ul><ul><li>Develop requirements for CMS </li></ul>
  • 24. Prototyping with a File System <ul><li>Controlled access to central repository folders </li></ul><ul><li>Consider serving source content through a web server – revisions managed manually through a single point of contact </li></ul><ul><li>Serve metadata and access through a database-driven website (SharePoint). </li></ul>
  • 25. Using Spreadsheet to Manage Metadata <ul><li>Spreadsheet captures and manages metadata about each topic in the repository </li></ul><ul><li>Advanced spreadsheet development controls transactions in the repository and metadata creation </li></ul><ul><li>Spreadsheet can be used to organize and aggregate content stored in the repository </li></ul><ul><li>Spreadsheet can be used as a source for database-driven web interface </li></ul>
  • 26. Using a Source Code-Management Tool <ul><li>Source-code management tools allow you to manage revisions and releases of content </li></ul><ul><li>Working with XML, you can use these tools to show differences between revisions </li></ul>
  • 27. Using a Component CMS to Manage Topics <ul><li>Advantages include: </li></ul><ul><ul><li>Automatic versioning of content </li></ul></ul><ul><ul><li>Automatic capture of metadata </li></ul></ul><ul><ul><li>Automatic file naming </li></ul></ul><ul><ul><li>Query-based search and retrieval of content </li></ul></ul><ul><ul><li>Automated workflow engine </li></ul></ul><ul><ul><li>Management reporting </li></ul></ul><ul><ul><li>Query-based content aggregation </li></ul></ul><ul><ul><li>Access control </li></ul></ul><ul><ul><li>Release management features </li></ul></ul>
  • 28. Thank you for attending <ul><li>Please contact me at: </li></ul><ul><li>rob. hanna @ ascan .ca </li></ul><ul><li>+1 (905) 997-6563 </li></ul><ul><li>Skype/AIM: singlesourceror </li></ul><ul><li>LinkedIn: http://www. linkedin .com/in/ singlesourceror </li></ul>
  • Search
    Related Search
    We Need Your Support
    Thank you for visiting our website and your interest in our free products and services. We are nonprofit website to share and download documents. To the running of this website, we need your help to support us.

    Thanks to everyone for your continued support.

    No, Thanks

    We need your sign to support Project to invent "SMART AND CONTROLLABLE REFLECTIVE BALLOONS" to cover the Sun and Save Our Earth.

    More details...

    Sign Now!

    We are very appreciated for your Prompt Action!