Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Don't Duplicate It, Include It

583 views

Published on

The presentation makes the case that it is better to create a separate Confluence wiki page for each topic than to create copies of that topic in multiple guides. It presents a sample structure for a user's guide created in Confluence that makes use of local content but also macros that pull in content from elsewhere, allowing you to use the same wiki topic in multiple guides.

Published in: Technology, Education

Don't Duplicate It, Include It

  1. 1. Carolyn Kelley Klinger http://www.slideshare.net/cklinger500/dont-duplicate-include-it
  2. 2. What is a Wiki?  A website that allows collaborative editing of its content and structure by its users Don’t Duplicate It, Include It!@cklinger #stc14 2
  3. 3. My Confluence Bias @cklinger #stc14 Don’t Duplicate It, Include It! 3
  4. 4. Wikis are Perfect for Documentation  One guide or one topic per wiki page  Content is always current  Everyone can see changes  Can roll back to previous versions  Can search content and attachments  Can restrict public viewing/editing of a page while it is in draft Don’t Duplicate It, Include It!@cklinger #stc14 4
  5. 5. Reuse vs. Duplication  Reuse  Duplication Guide 2, {Include Page|Wiki Page A} Don’t Duplicate It, Include It!@cklinger #stc14 5
  6. 6. Why Reuse Wiki Content?  You want…  Quality that results from eliminating human error  Accessibility of non-text content  Consistency of content and structure  You might need to save space Don’t Duplicate It, Include It!@cklinger #stc14 6
  7. 7. What’s Wrong with Duplication?  Version control issues  Have to edit in multiple places  Human error duplicates itself as well  Increased time and effort Don’t Duplicate It, Include It!@cklinger #stc14 7
  8. 8. How to Make a Wiki Guide 1. Create a new wiki page as a guide shell. 2. Create an inclusion library at the wiki root. 3. Write each topic as its own wiki page. 4. In the guide shell, include topics. @cklinger #stc14 8 1 3 2
  9. 9. Simple Guide Shell @cklinger #stc14 Don’t Duplicate It, Include It! 9
  10. 10. Guide Shell with Chapters @cklinger #stc14 Don’t Duplicate It, Include It! 10 Wiki editor view Published page view
  11. 11. Keep Inclusions Organized Store Inclusions at Wiki Root Level Each Version Has Unique Content @cklinger #stc14 Don’t Duplicate It, Include It! 11
  12. 12. Same Wiki Page, Two Versions Don’t Duplicate It, Include It!@cklinger #stc14 12
  13. 13. Common Macros  Page Information  Children Display  Include Page  Tip  Panel  Table of Contents Don’t Duplicate It, Include It!@cklinger #stc14 13
  14. 14. Pull In Content with Macros 1. Source Page 2. Tip Macro and Include Page Macro in C0nfluence Editor @cklinger #stc14 Don’t Duplicate It, Include It! 14 3. Published Content
  15. 15. Wiki Documentation Set Don’t Duplicate It, Include It!@cklinger #stc14 15
  16. 16. Published Wiki Guide @cklinger #stc14 Don’t Duplicate It, Include It! 16
  17. 17. Thank You! @cklinger #stc14 Don’t Duplicate It, Include It! 17 Image Source: http://learningwithwikis.wikispaces.com

×