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

Johannes Egenolf

Technical Writer &Customer Advocate, K15t Software

About Me

Get everyone involved: Technical Documentation with Wikis

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

> 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

Why Wikis for Documentation?

101

Out of the box –great for documentation

But –I have special needs!

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

Content Reuse

Page hierarchy

Inclusion library for reuse:> Only visible to authors

> Can be reused everywhere

> Page titel: _Modulename

> versioned (optional)

Managing Versions

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

AUTH

OR

Easy-to-Use Editor

Macros

Macros

Macros

> Work on upcoming releases in the background

> Edit pages for a specific release version

Versioning Content

Select the version you want to work on

Multilingual Content

Display the Confluence content in the right language

Guidance for Authors

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

TRACK

Automated Language Quality Checks

> 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!

> Are available for wikis, toowith add-ons (Comala).

> Track the content state.

> Restrictive workflows alone do not guarantee high quality!

Restrictions and Approval Workflows

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

PUBLISH

> 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

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

Web Publishing

http://www.KICK-ASS_WEBSITES_WITH_CONFLUENCE.com

• Public Wiki with Themes • Static HTML Export • Viewport for your Wiki

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

ENGAGE

Iterative development of documentation

Everyone contributes to the content:

> Developers

> Technical writers

> Quality assurance team members

Agile Documentation Workflows

> 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

PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

✔PLAN

AUTH

OR

TRACK

PUBLISH

ENGAGE

Wiki-based documentation works for all content lifecycle phases

Enterprise Wikis like Confluence already exist in many IT teams

Technical Writers become Information Managers

More than 13.000 organizations collaborate in Confluence

Questions & Answers

info@k15t.com @k15tsoftware www.k15t.com Today: Johannes

Stay in contact

Invitation: Webinar on Monday, September 29th „Content Management with Confluence“