![Page 1: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/1.jpg)
tekom Europe Roadshow 2014 24 September 2014, București !Johannes Egenolf, K15t Software GmbH
Get everyone involved: Technical Documentation with Wikis
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
![Page 2: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/2.jpg)
![Page 3: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/3.jpg)
Johannes Egenolf
Technical Writer &Customer Advocate, K15t Software
About Me
![Page 4: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/4.jpg)
Get everyone involved: Technical Documentation with Wikis
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
![Page 5: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/5.jpg)
> Why Wiki-based documentation?
Agenda
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE> Plan: Audiences, Structure, Versioning/Variants
> Author: Content creation in an Enterprise Wiki
> Track: Quality assurance, feedback and workflows
> Publish: Releasing and exporting content
> Engage: Agile documentation workflows
> Takeaways and Q&A panel
![Page 6: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/6.jpg)
Why Wikis for Documentation?
![Page 7: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/7.jpg)
101
![Page 8: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/8.jpg)
![Page 9: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/9.jpg)
![Page 10: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/10.jpg)
![Page 11: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/11.jpg)
![Page 12: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/12.jpg)
![Page 13: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/13.jpg)
![Page 14: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/14.jpg)
![Page 15: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/15.jpg)
![Page 16: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/16.jpg)
![Page 17: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/17.jpg)
Out of the box –great for documentation
![Page 18: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/18.jpg)
But –I have special needs!
![Page 19: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/19.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
![Page 20: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/20.jpg)
![Page 21: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/21.jpg)
Content Reuse
Page hierarchy
Inclusion library for reuse:> Only visible to authors
> Can be reused everywhere
> Page titel: _Modulename
> versioned (optional)
![Page 22: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/22.jpg)
Managing Versions
![Page 23: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/23.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
AUTH
OR
![Page 24: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/24.jpg)
Easy-to-Use Editor
![Page 25: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/25.jpg)
Macros
![Page 26: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/26.jpg)
Macros
![Page 27: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/27.jpg)
Macros
![Page 28: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/28.jpg)
> Work on upcoming releases in the background
> Edit pages for a specific release version
Versioning Content
Select the version you want to work on
![Page 29: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/29.jpg)
Multilingual Content
Display the Confluence content in the right language
![Page 30: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/30.jpg)
Guidance for Authors
![Page 31: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/31.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
TRACK
![Page 32: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/32.jpg)
Automated Language Quality Checks
![Page 33: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/33.jpg)
> Motivated Wiki authors mutually fix their errors.
> Content is improving based on feedback from other users.
Ex-post Approach for Quality Assurance
Good!Better!
Perfect!
![Page 34: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/34.jpg)
> Are available for wikis, toowith add-ons (Comala).
> Track the content state.
> Restrictive workflows alone do not guarantee high quality!
Restrictions and Approval Workflows
![Page 35: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/35.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
PUBLISH
![Page 36: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/36.jpg)
> Make content available when the product is released
> Readers can access the latest version and previous versions
Publishing Released Documentation
Select the version to publish
![Page 37: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/37.jpg)
Publishing to PDF, HTML, Word (single pages)ist a default functionality of enterprise wikis like Confluence.
Advanced publishing using add-ons:
Export Formats
Document-centric Context-sensitive help
![Page 38: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/38.jpg)
Web Publishing
http://www.KICK-ASS_WEBSITES_WITH_CONFLUENCE.com
• Public Wiki with Themes • Static HTML Export • Viewport for your Wiki
![Page 39: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/39.jpg)
![Page 40: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/40.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
ENGAGE
![Page 41: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/41.jpg)
Iterative development of documentation
Everyone contributes to the content:
> Developers
> Technical writers
> Quality assurance team members
Agile Documentation Workflows
![Page 42: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/42.jpg)
> Public product documentation
> Everyone can comment and interact
> Sharing insights, feedback, questions, answers …
Involve Your Customers – Example: Atlassian
https://confluence.atlassian.com/display/DOC/Cheese+Macro
![Page 43: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/43.jpg)
PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
✔PLAN
AUTH
OR
TRACK
PUBLISH
ENGAGE
![Page 44: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/44.jpg)
Wiki-based documentation works for all content lifecycle phases
![Page 45: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/45.jpg)
Enterprise Wikis like Confluence already exist in many IT teams
![Page 46: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/46.jpg)
Technical Writers become Information Managers
![Page 47: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/47.jpg)
More than 13.000 organizations collaborate in Confluence
![Page 48: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/48.jpg)
Questions & Answers
![Page 49: Get Everyone Involved: Technical Communication with Wikis](https://reader033.vdocument.in/reader033/viewer/2022052901/5564a4d8d8b42ab8278b57dc/html5/thumbnails/49.jpg)
[email protected] @k15tsoftware www.k15t.com Today: Johannes
Stay in contact
Invitation: Webinar on Monday, September 29th „Content Management with Confluence“