Confluence, Tech Comm, Chocolate

Scheduled for February, 2012

Web and Technical Comm guru Sarah Maddox takes you inside the Confluence wiki for an in-depth guide to developing and publishing technical documentation on a wiki. She looks at life on a wiki from a technical writer’s point of view and from a reader’s point of view. Confluence, Tech Comm, Chocolate shows you how to make your wiki fly.

While it focuses on Confluence, the concepts and strategies can be used with any wiki. The basic message is that technical documentation becomes true communication when you add the social and collaborative tools that a wiki provides.

And, there’s chocolate.

Who is the girl on the cover?

Her name is Ganache, and she is the hero of the book. She is a technical communicator extraordinaire. When you read the book, you will follow Ganache as she sets up a Confluence wiki and adds a technical documentation space. Learn from her expertise with the wiki editor and macros. Share her adventures in agile development and search engine optimisation. Grow wings, as Ganache does, and make your wiki documentation fly. Discover why Ganache says we need a “kiss my wiki” attitude.

Guess her name contest

Congratulations to Jill Brockmann, who correctly guessed Ganache’s name in our contest. She will receive a copy of the book once it has been published. You still have a chance to win a free copy of the book. Just sign up for the Confluence, Tech Comm, Chocolate newsletter below, and we will enter you in the contest.

Inside the Book

1. Introduction
   1. Welcome to this Book
   2. Introducing the Wiki
   3. Getting to Know Confluence Wiki
2. Developing Technical Documentation on a Wiki
   4. Planning Your Wiki Documentation
   5. Getting Started on the Wiki
   6. Developing Content
   7. Structure and Style
   8. Content Reuse and Templates
   9. Findability and Searchability
   10. Workflow and Release Management
   11. Exporting and Importing Content
   12. Building Online Help
3. Life on a Wiki
   13. A Day in the Life
   14. What’s Happening on the Wiki
   15. Wiki Best Practices and FAQ
   16. Going Agile
4. Giving Your Wiki Wings
   17. Engaging Your Readers
   18. Gathering Feedback on the Documentation
   19. Updates by Everyone
   20. Pages that Walk and Talk
   21. Twitter, Wiki, and Games
   22. Doc Sprints
   23. Driving Wiki Development
5. So Long and See You on the Wiki
6. Glossary
7. Index

About Sarah Maddox

Sarah Maddox is a technical writer at Atlassian, makers of software tools for technical teams. She started her working life as a software developer in South Africa and Europe, did a stint as a book indexer, and then moved into the best job of all: writing docs that rock. She now lives in a house on a hill in Australia amongst the kookaburras and possums. You can read Sarah’s blog at: ffeathers.wordpress.com

Sign up for Chance to Win a Copy of this Book

Sign up for the Confluence, Tech Comm, Chocolate newsletter, and you will be entered into a drawing for a free copy of this book.

Your email address will only be used to send you the newsletter(s) you request, and will not be sold or used in any other way (see our Privacy Policy for details).