Over the past month we have explored the world of technical documentation in Confluence and gotten a taste of Sarah Maddox’s new book: Confluence, tech comm, chocolate: A wiki as platform extraordinaire for technical communication. We hope that you have picked up some helpful tips and tricks or even changed the way you think about or produce technical documentation in your organization.
That’s a Wrap, Folks!
To celebrate the end of this series we want to invite everyone to join us for a free webinar on Confluence as a Platform for Technical Documentation. It will be the perfect way for you to meet Sarah and conclude this great series on using a wiki for technical documentation. So, don’t forget to register!
In case you didn’t get to read all of the posts here are brief summaries of what we’ve covered over the last month.
A Day in the Life of a Technical Writer
Ganache is the hero of Confluence, Tech Comm, Chocolate. She is a technical writer at Choc Ink, a fictitious company specializing in software tools for the chocolate industry. Two of those tools are ChocTactics and ChocSpice. Ganache spends most of her day on the wiki.
Lets take a look at how Ganache spends a typical day at Choc Ink managing the technical documentation for the company.
Managing Updates for Everyone
In this post we introduce you to one of the 5 Cs of technical communication: Collaboration!
Collaboration – that’s what a wiki is designed for. Imagine an ideal world, where technical writers design the structure of a documentation set and create the first version of the documents. From that point on, the subject matter experts share the task of maintenance, giving the writers more time to develop new documents. We all focus on what we know best. What a dream!
Turning Documentation into Communication
Everyone knows the saying: A picture is worth a thousand words. Many people absorb information more quickly from a good image or diagram than from a block of text. But there’s more to it than that. Attractive and interesting pages attract people. By engaging our readers’ interest, we are making it easier for them to focus on and understand the information on the page. In other words, there’s more to it than pictures. Even if a good picture is worth 10 chocolates!
Funky Tidbits for Technical Writers
In times of yore, web pages used to just put themselves up in front of you and that was that. Then along came the first wiki, and our lives changed for ever. Suddenly we could click a button and change the content of the web page. Even more revolutionary was that we could click “Save” and have our changes visible to the rest of the world. Immediately.
In this post we delight you with a collection of hints and tips that we hope you will find useful and fun!
Driving Wiki Development
The wiki world is one of innovation and ideas. People dream, then build their dreams. Technical communicators, too. Confluence is a platform extraordinaire for technical communication, but it’s not perfect yet. We can help to make it so. The wiki is extensible. That’s what makes it a platform to dream of.
Images are copyright © Ryan Maddox, 2012
At Atlassian the process of creating technical documentation has evolved to become integral to the success of our products. It brings them to life through the words and visual representations created by our technical writing team. We hope that using Confluence for your documentation can help you breathe new life into your documentation process, your products, and your general workflow as well.
See it in Action!
Live Webinar: Confluence as a Platform for Technical Documentation
Save the date! Thursday April 12th, 2012 | 8:00 AM PST
Join Atlassian technical writer Sarah Maddox, as she shows how she used Confluence to author her book and shares how you can customize Confluence to fit your technical documentation requirements. Special guests from Stepstone Technologies and k15t Software will demonstrate how their add-ons make it easy to brand your online documentation and facilitate the entire documentation lifecyle with Confluence.
Get the Book
Sarah’s book is filled with creative tips and tricks for encouraging the use of your wiki and bringing your technical writing team together. So, what are you waiting for? Buy the book Confluence, tech comm, chocolate: A wiki as platform extraordinaire for technical communication today to learn more!
Try Confluence Today
Give your technical documentation a boost with Confluence. Start a free 30-day trial and see how easy it is to start developing your technical documentation. With licenses starting at $10 for 10 user, OnDemand or Download, you can’t go wrong.