SlideShare uma empresa Scribd logo
1 de 17
Carolyn Kelley Klinger
http://www.slideshare.net/cklinger500/dont-duplicate-include-it
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
My Confluence Bias
@cklinger #stc14 Don’t Duplicate It, Include It! 3
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
Reuse vs. Duplication
 Reuse
 Duplication
Guide 2,
{Include Page|Wiki Page A}
Don’t Duplicate It, Include It!@cklinger #stc14 5
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
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
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
Simple Guide Shell
@cklinger #stc14 Don’t Duplicate It, Include It! 9
Guide Shell with Chapters
@cklinger #stc14 Don’t Duplicate It, Include It! 10
Wiki editor view
Published page view
Keep Inclusions Organized
Store Inclusions at Wiki Root Level Each Version Has Unique Content
@cklinger #stc14 Don’t Duplicate It, Include It! 11
Same Wiki Page, Two Versions
Don’t Duplicate It, Include It!@cklinger #stc14 12
Common Macros
 Page Information
 Children Display
 Include Page
 Tip
 Panel
 Table of Contents
Don’t Duplicate It, Include It!@cklinger #stc14 13
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
Wiki Documentation Set
Don’t Duplicate It, Include It!@cklinger #stc14 15
Published Wiki Guide
@cklinger #stc14 Don’t Duplicate It, Include It! 16
Thank You!
@cklinger #stc14 Don’t Duplicate It, Include It! 17
Image Source: http://learningwithwikis.wikispaces.com

Mais conteúdo relacionado

Semelhante a Don't Duplicate It, Include It

Lecture 23 Wikis & Writing
Lecture 23  Wikis & WritingLecture 23  Wikis & Writing
Lecture 23 Wikis & Writing
Jessica Laccetti
 
Wikis
WikisWikis
Wikis
Sarai
 
Lecture 24 2012 Wikis & Writing
Lecture 24 2012  Wikis & WritingLecture 24 2012  Wikis & Writing
Lecture 24 2012 Wikis & Writing
Jessica Laccetti
 
World oceansday wiki-snyder2015
World oceansday wiki-snyder2015World oceansday wiki-snyder2015
World oceansday wiki-snyder2015
Sara Snyder
 

Semelhante a Don't Duplicate It, Include It (20)

MediaWiki Quick Start Guide
MediaWiki Quick Start GuideMediaWiki Quick Start Guide
MediaWiki Quick Start Guide
 
The web 2 world duffield oct 09
The web 2 world duffield oct 09The web 2 world duffield oct 09
The web 2 world duffield oct 09
 
Why Use A Wiki: An Introduction to the Latest Online Publishing Format
Why Use A Wiki: An Introduction to the Latest Online Publishing FormatWhy Use A Wiki: An Introduction to the Latest Online Publishing Format
Why Use A Wiki: An Introduction to the Latest Online Publishing Format
 
Lecture 23 Wikis & Writing
Lecture 23  Wikis & WritingLecture 23  Wikis & Writing
Lecture 23 Wikis & Writing
 
Blogs And Wikis In Academia
Blogs And Wikis In AcademiaBlogs And Wikis In Academia
Blogs And Wikis In Academia
 
\\Tsclient\Usbdrvs\Noname\Wikis
\\Tsclient\Usbdrvs\Noname\Wikis\\Tsclient\Usbdrvs\Noname\Wikis
\\Tsclient\Usbdrvs\Noname\Wikis
 
Wikis
WikisWikis
Wikis
 
Wikis
WikisWikis
Wikis
 
Lecture 24 2012 Wikis & Writing
Lecture 24 2012  Wikis & WritingLecture 24 2012  Wikis & Writing
Lecture 24 2012 Wikis & Writing
 
Wikis In Physical Education
Wikis In Physical EducationWikis In Physical Education
Wikis In Physical Education
 
Wiki development committee
Wiki development committeeWiki development committee
Wiki development committee
 
Wikis
WikisWikis
Wikis
 
Reading Wikipedia in the classroom (student edition)
Reading Wikipedia in the classroom (student edition)Reading Wikipedia in the classroom (student edition)
Reading Wikipedia in the classroom (student edition)
 
World oceansday wiki-snyder2015
World oceansday wiki-snyder2015World oceansday wiki-snyder2015
World oceansday wiki-snyder2015
 
Wikis 101
Wikis 101Wikis 101
Wikis 101
 
OWASP Wikipedia Training Presentation
OWASP Wikipedia Training PresentationOWASP Wikipedia Training Presentation
OWASP Wikipedia Training Presentation
 
Wikipedia Tutorials
Wikipedia TutorialsWikipedia Tutorials
Wikipedia Tutorials
 
Darya Tarasowa. SlideWiki. Description
Darya Tarasowa. SlideWiki. DescriptionDarya Tarasowa. SlideWiki. Description
Darya Tarasowa. SlideWiki. Description
 
Wonderful world of wiki teaching 2012 edition
Wonderful world of wiki teaching   2012 editionWonderful world of wiki teaching   2012 edition
Wonderful world of wiki teaching 2012 edition
 
Wonderful world of wiki teaching 2012 edition
Wonderful world of wiki teaching   2012 editionWonderful world of wiki teaching   2012 edition
Wonderful world of wiki teaching 2012 edition
 

Último

Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Safe Software
 
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
?#DUbAI#??##{{(☎️+971_581248768%)**%*]'#abortion pills for sale in dubai@
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Safe Software
 
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
Victor Rentea
 

Último (20)

Understanding the FAA Part 107 License ..
Understanding the FAA Part 107 License ..Understanding the FAA Part 107 License ..
Understanding the FAA Part 107 License ..
 
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin WoodPolkadot JAM Slides - Token2049 - By Dr. Gavin Wood
Polkadot JAM Slides - Token2049 - By Dr. Gavin Wood
 
Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdf
 
Artificial Intelligence Chap.5 : Uncertainty
Artificial Intelligence Chap.5 : UncertaintyArtificial Intelligence Chap.5 : Uncertainty
Artificial Intelligence Chap.5 : Uncertainty
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
+971581248768>> SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHA...
 
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdfRising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
Rising Above_ Dubai Floods and the Fortitude of Dubai International Airport.pdf
 
Apidays New York 2024 - Passkeys: Developing APIs to enable passwordless auth...
Apidays New York 2024 - Passkeys: Developing APIs to enable passwordless auth...Apidays New York 2024 - Passkeys: Developing APIs to enable passwordless auth...
Apidays New York 2024 - Passkeys: Developing APIs to enable passwordless auth...
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
presentation ICT roal in 21st century education
presentation ICT roal in 21st century educationpresentation ICT roal in 21st century education
presentation ICT roal in 21st century education
 
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
Modular Monolith - a Practical Alternative to Microservices @ Devoxx UK 2024
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
Apidays New York 2024 - APIs in 2030: The Risk of Technological Sleepwalk by ...
Apidays New York 2024 - APIs in 2030: The Risk of Technological Sleepwalk by ...Apidays New York 2024 - APIs in 2030: The Risk of Technological Sleepwalk by ...
Apidays New York 2024 - APIs in 2030: The Risk of Technological Sleepwalk by ...
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Introduction to Multilingual Retrieval Augmented Generation (RAG)
Introduction to Multilingual Retrieval Augmented Generation (RAG)Introduction to Multilingual Retrieval Augmented Generation (RAG)
Introduction to Multilingual Retrieval Augmented Generation (RAG)
 
Elevate Developer Efficiency & build GenAI Application with Amazon Q​
Elevate Developer Efficiency & build GenAI Application with Amazon Q​Elevate Developer Efficiency & build GenAI Application with Amazon Q​
Elevate Developer Efficiency & build GenAI Application with Amazon Q​
 
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
Apidays New York 2024 - The Good, the Bad and the Governed by David O'Neill, ...
 
Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...
Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...
Biography Of Angeliki Cooney | Senior Vice President Life Sciences | Albany, ...
 
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
Navigating the Deluge_ Dubai Floods and the Resilience of Dubai International...
 
DEV meet-up UiPath Document Understanding May 7 2024 Amsterdam
DEV meet-up UiPath Document Understanding May 7 2024 AmsterdamDEV meet-up UiPath Document Understanding May 7 2024 Amsterdam
DEV meet-up UiPath Document Understanding May 7 2024 Amsterdam
 

Don't Duplicate It, Include It

  • 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. My Confluence Bias @cklinger #stc14 Don’t Duplicate It, Include It! 3
  • 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. Reuse vs. Duplication  Reuse  Duplication Guide 2, {Include Page|Wiki Page A} Don’t Duplicate It, Include It!@cklinger #stc14 5
  • 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. 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. 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. Simple Guide Shell @cklinger #stc14 Don’t Duplicate It, Include It! 9
  • 10. Guide Shell with Chapters @cklinger #stc14 Don’t Duplicate It, Include It! 10 Wiki editor view Published page view
  • 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. Same Wiki Page, Two Versions Don’t Duplicate It, Include It!@cklinger #stc14 12
  • 13. Common Macros  Page Information  Children Display  Include Page  Tip  Panel  Table of Contents Don’t Duplicate It, Include It!@cklinger #stc14 13
  • 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. Wiki Documentation Set Don’t Duplicate It, Include It!@cklinger #stc14 15
  • 16. Published Wiki Guide @cklinger #stc14 Don’t Duplicate It, Include It! 16
  • 17. Thank You! @cklinger #stc14 Don’t Duplicate It, Include It! 17 Image Source: http://learningwithwikis.wikispaces.com

Notas do Editor

  1. CollaborationView and edit restrictionsEasy to useGreat for Agile with JIRA