Wiki Do


Published on

Published in: Technology
  • Be the first to comment

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide
  • Welcome & Intro – Please ask questions throughout… Who here has written documentation for code, a service, a system, process, procedure or policy? Who here was suppose to write documentation but ran out of time before the next project started or the next fire had to be put out? Who here has a fast, easy documentation system that is able to be used by every member of your team to create and maintain documentation? Well, don’t worry – you’re in the right session
  • Wiki Do

    1. 1. Wiki-Do The Way of the Wiki Sean Yo Computing and Communications Services University of Guelph
    2. 2. What is a Wiki? <ul><li>A Wiki is a tool for creating and managing web-published content </li></ul><ul><ul><li>Articles are authored with simple text markup through the web </li></ul></ul><ul><ul><li>Changes are tracked and can be rolled back </li></ul></ul><ul><ul><li>Articles can link together, forming networks of information </li></ul></ul><ul><ul><li>ALL content can be changed by EVERYONE </li></ul></ul><ul><li>Wikipedia is an popular example of a Wiki </li></ul>
    3. 3. What Do Wikis Deliver? <ul><li>Content becomes a partnership, a communal project </li></ul><ul><li>“ Instant” Authoring </li></ul><ul><ul><li>Updates, Corrections, Deletions & New Articles </li></ul></ul><ul><li>Versioning </li></ul><ul><ul><li>Who Made an Edit, What was Edited, When was it Edited </li></ul></ul><ul><ul><li>Easy to view or even roll back to any version of the article </li></ul></ul><ul><li>Easy to follow what’s new/changed </li></ul><ul><li>Geek Street Cred </li></ul>
    4. 4. Why Do Wikis Matter? <ul><li>Obligatory Google Quote: </li></ul><ul><li>“ This company runs on wikis.” - Shashi Seth, Sr. Product Manager at Google </li></ul>
    5. 5. Why Do Wikis Matter? <ul><li>Wikis deliver on the promise of the Web </li></ul><ul><ul><li>Original Design of the Web </li></ul></ul><ul><ul><ul><li>Intended uses include Centralized Publishing & Collaborative Authoring </li></ul></ul></ul><ul><ul><ul><li>Multi-user system where all users can edit pages </li></ul></ul></ul><ul><ul><ul><li>Version Control – page “histories” </li></ul></ul></ul><ul><ul><ul><li>Notification of New Content </li></ul></ul></ul><ul><ul><li>Wikis are a system where information is easily shared, where readers and authors are one and the same. </li></ul></ul>
    6. 6. Why Do Wikis Matter? <ul><li>Easy and effective </li></ul><ul><li>Make documenting simple and usable </li></ul><ul><li>Designed for collaboration and coordination </li></ul><ul><li>Make authoring content fast and easy </li></ul><ul><li>Deliver instant gratification for updating and maintaining content </li></ul><ul><li>Documentation Holy Grail </li></ul>
    7. 7. How do Wikis Work? <ul><li>informal, quick & accessible; remarkably easy to set up. </li></ul><ul><li>Wiki As Technology </li></ul><ul><ul><li>Reduces the barrier to entry to almost zero </li></ul></ul><ul><ul><li>Designed from the ground up for multiple authors </li></ul></ul><ul><ul><li>Easy to access anywhere, making it remarkably useable </li></ul></ul><ul><ul><li>Separates Content from Discussion </li></ul></ul><ul><li>Wiki Culture </li></ul><ul><ul><li>Creating an article becomes only as hard as it is to write </li></ul></ul><ul><ul><ul><li>No arcane CMS or being powerless to publish </li></ul></ul></ul><ul><ul><li>Community of authors and readers </li></ul></ul><ul><ul><li>“ Refactoring makes the work supple” </li></ul></ul>
    8. 8. How Do Wikis Work? <ul><li>Open access to content. </li></ul><ul><ul><li>ALL content can be changed by EVERYONE </li></ul></ul><ul><li>“ Well, nice idea, but it'll never work. People will just ruin it!”. </li></ul><ul><li>3 reasons Wikis don't just fall apart: </li></ul><ul><ul><li>Everyone can edit – if there is vandalism, you can just fix it! </li></ul></ul><ul><ul><li>Wikis create communities which care for the Wiki </li></ul></ul><ul><ul><li>Changes are tracked. It takes trivial effort to repair damage </li></ul></ul>
    9. 9. How do Wikis Not Work? <ul><li>Wiki as Technology </li></ul><ul><ul><li>Webserver outage </li></ul></ul><ul><ul><li>User experience of using “wiki markup” for authoring </li></ul></ul><ul><li>Wiki as Culture </li></ul><ul><ul><li>Content Integrity </li></ul></ul><ul><ul><ul><li>Wikis have no editorial control </li></ul></ul></ul><ul><ul><ul><li>Can lead to inaccurate or duplicate articles </li></ul></ul></ul><ul><ul><ul><li>Content and style guides are essential </li></ul></ul></ul><ul><ul><li>Edit Wars </li></ul></ul><ul><ul><ul><li>If a community form around a point of view, it can lead to an article “tug-of-war” </li></ul></ul></ul>
    10. 10. Public Vs. Private Wikis <ul><li>The original Wiki idea is firmly grounded in public access. </li></ul><ul><ul><li>Anonymity is an important factor as well </li></ul></ul><ul><li>Wikis can be configured to be private </li></ul><ul><ul><li>All the benefits of a Wiki </li></ul></ul><ul><ul><li>None of the potential complications </li></ul></ul><ul><li>Private wikis should be free from dealing with issues of vandalism and edit wars. </li></ul>
    11. 11. Why Use a Wiki? <ul><li>Wikis will work for </li></ul><ul><ul><li>A group or a team of authors </li></ul></ul><ul><ul><li>Writing and maintaining centralized, authoritative documents </li></ul></ul><ul><li>Wikis enable fast, easy collaboration </li></ul><ul><li>Wikis empower people to share in the ownership of content and the systems, services, processes, policies and procedures they document </li></ul><ul><li>Wikis require collaboration – Wikis help build teams </li></ul><ul><li>Wikis enable teams to be more productive, effective and agile by solving the documentation problem </li></ul>
    12. 12. Why Should You Use Wikis? <ul><li>How can Higher Ed IT best use a Wiki? </li></ul><ul><li>Collaborative Technical Documentation </li></ul><ul><ul><li>Original use case for Wikis </li></ul></ul><ul><ul><li>Large, complex, ever-changing systems </li></ul></ul><ul><ul><li>Prioritizing documentation is a challenge </li></ul></ul><ul><ul><li>Change management is a challenge </li></ul></ul><ul><ul><li>Developing institutional memory is a challenge </li></ul></ul><ul><ul><li>Content is intended for a small group or team </li></ul></ul>
    13. 13. Why Should You Use Wikis? <ul><li>Large, complex, ever-changing systems </li></ul><ul><ul><li>Wikis are an organic system which can grow with whatever system it is documenting </li></ul></ul><ul><li>Prioritizing documentation is a challenge </li></ul><ul><ul><li>Wikis make documentation as painless as possible </li></ul></ul><ul><li>Change management is a challenge </li></ul><ul><ul><li>Easy to maintain documentation supports and encourages documenting change </li></ul></ul><ul><li>Developing institutional memory is a challenge </li></ul><ul><ul><li>Wikis provide an ongoing history that is easily accessible, using current documentation as the point of reference </li></ul></ul><ul><li>Content is intended for a small group or team </li></ul><ul><ul><li>Wikis can be “walled” off for private consumption only </li></ul></ul>
    14. 14. Wiki Patterns for I.T. <ul><li>Collaborative Technical Documentation </li></ul><ul><ul><li>Service & Product documentation </li></ul></ul><ul><ul><li>Installation/Migration notes </li></ul></ul><ul><ul><li>Procedures, Recipes and How-To’s </li></ul></ul><ul><ul><li>Meeting Minutes </li></ul></ul><ul><ul><li>To Do tracking </li></ul></ul><ul><li>Other patterns include such use cases as project management and even an agile content management system </li></ul>
    15. 15. Wiki Patterns for I.T. <ul><li>Private Wiki </li></ul><ul><li>Defined Content Schema </li></ul><ul><ul><li>Service based content architecture </li></ul></ul><ul><ul><li>Project tracking which becomes service pages </li></ul></ul><ul><li>Clear content and style guides </li></ul><ul><li>Build value for the team to drive adoption </li></ul><ul><li>Collaborative model </li></ul><ul><ul><li>No “owners” of an article </li></ul></ul>
    16. 16. MediaWiki <ul><li>MediaWiki </li></ul><ul><ul><li>Software developed for Wikipedia </li></ul></ul><ul><ul><li>Well positioned to become a standard, much like Apache for web hosting </li></ul></ul><ul><ul><li>Open Source software </li></ul></ul><ul><ul><li>Very well suited for teams </li></ul></ul><ul><li>MediaWiki Set Up </li></ul><ul><ul><li>LAMP Server (PHP & MySQL required) </li></ul></ul><ul><ul><li>MediaWiki code </li></ul></ul><ul><ul><li>Install Script </li></ul></ul>
    17. 17. MediaWiki in Action
    18. 18. How to Design a Wiki <ul><li>Every Wiki Needs A Plan </li></ul><ul><ul><li>Content Schema (Information Architecture) </li></ul></ul><ul><li>Use the MainPage as the Wiki Start Page </li></ul><ul><li>Use Categories and Subcategories </li></ul><ul><ul><li>Remember: categories are like tags. Articles can have multiple categories </li></ul></ul><ul><li>Use Subpages </li></ul><ul><ul><li>Allows a hierarchal organization of articles </li></ul></ul><ul><ul><li>Breadcrumb style navigation </li></ul></ul>
    19. 19. How to Work with Wikis <ul><li>Wikis work when they are driven by a community/team working toward the same goal </li></ul><ul><li>Follow the Plan </li></ul><ul><li>Recent Changes Page keeps users up to date </li></ul><ul><ul><li>Recent changes is syndicated out of the box </li></ul></ul><ul><ul><ul><li>RSS & ATOM </li></ul></ul></ul><ul><li>Enforce separation of content and discussion </li></ul><ul><li>Make changes as needed </li></ul><ul><ul><li>Wiki content is intended to be refactored whenever it is needed. Don’t worry…you can always go back! </li></ul></ul>
    20. 20. Planting Your Own Wiki <ul><li>Build Strong Buy-In </li></ul><ul><ul><li>Take the plunge and fix it as you go </li></ul></ul><ul><ul><li>Wikis are designed to refactor content </li></ul></ul><ul><li>Convince by doing </li></ul><ul><ul><li>Use a “bite-size” project to prove “Wikis Work” </li></ul></ul><ul><ul><li>Get people involved – assign articles to write or review to get them to take the plunge </li></ul></ul><ul><ul><li>Once people start using a Wiki, they won’t want to stop </li></ul></ul>
    21. 21. How to Care for your Wiki <ul><li>To thrive Wikis need to be watered, weeded and pruned </li></ul><ul><ul><li>A core team should be responsible for monitoring activity and supporting the use of content and style guides </li></ul></ul><ul><ul><li>Clean up duplicate articles or misplaced articles </li></ul></ul><ul><li>Wabi-Sabi </li></ul><ul><ul><li>The beauty of things imperfect, impermanent, and incomplete. </li></ul></ul><ul><li>Wikis are FUN! Wikis are wide open spaces. </li></ul><ul><ul><li>Make it your own and don’t forget to play </li></ul></ul>
    22. 22. May The Wiki Be With You <ul><li>Wikis are a powerful community/team driven information management tool </li></ul><ul><li>Wikis are informal, quick & accessible; remarkably easy to set up. </li></ul><ul><li>Allows for process to be determined by how people work, not how the software works </li></ul><ul><li>Want to talk Wikis? </li></ul><ul><li>Sean Yo [email_address] </li></ul>