Is your strategy for the tekom/tcworld Conference dialed in and ready to roll? Since tekom is the world’s largest technical communication summit, qualification event, and trade fair, your plan is worth a bit of thought. And as you’ll soon learn, the event has several traits that make it particularly German in character: it's well organized, business driven, and has a strong focus on factual content. We hope we can make it a more enjoyable experience for you, with our unofficially-definitive tekom/tcworld Conference Guide featuring six pro tips from guest blogger and tekom veteran Martin Häberle https://twitter.com/martinhaeberle.
We're just a few weeks away from Atlassian Summit 2015 http://summit.atlassian.com/, and this year K15t Software is bringing new product news, demos, and lots of friendly faces with us from Stuttgart to the Big Powwow by the Bay.
Last Wednesday we threw open the K15t doors to friends, family, partners, and customers to help us warm our new office https://twitter.com/search?q=k15twarming in Stuttgart, and it was a grand time if we do say so ourselves. Check out some scenes from the event after the jump.
“No one reads documentation, and nobody gives feedback on it.” This phrase is bad news for technical communicators – but it’s not the whole story. What actually happens in reality hinges on the way we manage and distribute technical content. (Protip: Host it on the web and invite everyone to get involved). This is the second part in our blog post series https://www.k15t.com/blog/2015/07/feedback-please-why-technical-writing-shouldn-t-be-a-one-way-street about the benefits of crowd-enabled documentation using a collaborative approach. In this post you’ll learn how to get readers’ feedback on documentation easily by building collaborative web-based help content that allows technical communicators to elevate the quality of their work to the next level.
K15t Software has grown once again, and to keep us all from elbowing one another we had to make a change. With a bit of work we have found...
We've now had a week to reflect on our K15t Out-of-Office Adventure, and the unanimous verdict is in: We can't wait to start planning the next one!
For a long time, technical writing was like driving down a one-way street. We’ve sent information into one direction, and nothing came back. But since the age of the Web 2.0, this approach is no longer a best practice. Today, being a technical writer means to communicate and to interact with everyone involved – including our readers. Building documentation heavily depends on feedback, and it’s an iterative process – more like a traffic circle. New processes require new technology – it’s time to move from publishing tools to collaboration platforms. This blogpost is part of a series about feedback in technical communication, In this article, read why receiving feedback is crucial to create helpful technical content and how a web-based collaboration platform can enable both internal feedback and customer feedback.
Last week we had the third Dev Together event at K15t Software. It was a great opportunity for us to bring together Atlassian users, customers & friends to our new office situated in the lovely East End of Stuttgart.
.We would like to invite you the next installment of our Dev Together event series on June 16th, 2015 at 18:00 at our new office in Ostendstr. 110, Stuttgart. This time Dave Meyer of Atlassian and Thomas Büschgens of W&W Informatik GmbH will talk about how they use JIRA. Join us for the talks and for drinks and pizzas afterwards.
Oops, we did it again – and we love it: Creating awesome stuff within 24 hours. Some of us were coding almost the whole night to make our ideas come to life. Here's how we spent our third, Atlassian-rules https://www.atlassian.com/company/about/shipit hackathon that took place in the K15t Software office. And, of course, we've got a winning team: congratulations to Eugen, Maximilian, and Tobias who have built and demoed an awesome multi-layer image map editor for Confluence!
Today, I'd like to share with you a little secret about Scroll Translations. It’s the Confluence add-on which lets you manage Confluence content in multiple languages within a single space. This makes it simple to add page translations. But how about page templates and blueprints? Does the same apply to them? The answer is yes. It's not only possible to create multilingual page templates – it’s easy. In this blogpost, I'll show you how to modify the troubleshooting blueprint (or any other page template) and make it speak in foreign tongues.
The Scroll Viewport 2.1 release is dedicated to all the viewport theme developers out there! Creating and editing viewport themes is now easier than ever (forget FTP!). Here are six reasons why you folks (not only theme developers!) should embrace Scroll Viewport 2.1 – the latest version of an add-on for Confluence that's also a framework for delivering Confluence content even simpler and faster to the web.
Today, we’re going to settle the question once and for all – which is superior? Documentation in a plain-text editor using Markdown, or creating content in a rich-text editor the WYSIWYG (what you see is what you get) way? How will it be decided, you ask? A good, clean head-to-head fight!
Bringing people together in a collaboration platform like Atlassian Confluence also means transferring your legacy content from multiple information silos. These repositories often contain important information that you can’t afford to leave by the wayside when building a new corporate knowledge base. In many cases, legacy content is only available as HTML files, such as online help resources or intranet pages. Is there a way to bring these assets into Confluence efficiently? Yes – but there is no one-size-fits-all method. There are three main approaches to importing a collection of static HTML pages. Your individual needs will determine which is best for you.
What would you call the image on the right? A ‘drop-down list’? A ‘pull-down’ or ‘select list’? A ‘drop-box’? I recently discussed this very issue with one of our Atlassian Expert consultants. It seems everyone – from customers to consultants, developers and tech writers – has their own name for this UI element. We constantly refer to it in meetings, specs and technical documentation, but often do so in different ways. Consistent wording is key to delivering clear, readable documentation. But when larger groups of authors collaborate to write documentation, they tend to use different words for the same things – such as jargon, or incorrect or obsolete terms. This is where terminology management comes to the rescue. This blog post describes how you can build a glossary in Confluence to ensure terminology consistency. What’s more, I’ll show you a way to check your Confluence content for terminology and writing style.
A king would never walk to the library if he wanted to consult a book. Rather than climbing down from his throne, he’d tell one of his servants to find the desired volume and bring it to him, wherever it may be. Today, all users are treated like royalty in the sense that they have instant access to information of all kinds. Context-sensitive help does the job of the king’s servants – providing the required knowledge directly and conveniently, and sparing users the bother of interrupting their work to browse through the entire help library. Imagine that a user needs advice on which option in a dialog window to choose. Clicking the help button or pressing the F1 key pulls up the relevant help topic right away. To be truly useful, help content must be provided at the right time and in the right form. And when it comes to creating and distributing help resources, what could be better than Confluence, the collaborative, web-based knowledge platform? Here are four tips for providing context-sensitive online help fit for a king.
Confluence 5.7 is the first release to boast inline comment functionality. The entire Confluence user community – including ourselves here at K15t Software – instantly fell in love with this new way to close the content feedback loop. But can inline comments be used for questions and feedback on public documentation sites? Or are comment threads below pages still the best way to interact? This key issue was recently discussed on the Atlassian Confluence documentation site. Here’s a wrap-up of that discussion https://confluence.atlassian.com/display/DOC/Supported+Platforms?focusedCommentId=712639181#comment-712639181 – plus some best practices for using inline comments or choosing (threaded) page comments in Confluence 5.7.
When we first released Scroll Viewport on the Atlassian Marketplace in 2013, we claimed it was the best way to publish from Confluence to the web. Since then, we’ve learned a great deal from numerous website projects – and as a result, we’ve reconsidered the whole concept and spent many hours working on developments. Now, we’re proud to present Scroll Viewport 2.0 – a Confluence add-on that's a framework for delivering Confluence content even simpler and faster to the web.
When creating and updating documentation, it is often necessary to search for and replace text fragments. If, for example, a product name changes, authors need to update every single occurrence within their documentation. What if there was a way to automate this process? Atlassian Confluence’s built-in editor features a handy search-and-replace tool. Unfortunately, it doesn’t offer a way to exchange strings on multiple pages, across spaces or throughout the entire collaboration platform – and it’s unlikely that such a feature will be added any time soon. Instead, Confluence’s product managers point us to the Atlassian Marketplace, where third-party developers can provide suitable add-ons. In this blog post, I’ll take a closer look at one solution – available for Confluence 5 and above – that will help you search and replace Confluence content like a pro.
In medieval times, merchants used an Exchequer table to perform calculations for taxes and goods – and tables have been considered the best way to compile and compare data ever since. Tables can display large volumes of structured information in a highly compact and logical way. And today, spreadsheets enable us to calculate and process data electronically. Technical communicators rely on tables and comparison matrices to provide their readers with value-added information. So when using Atlassian Confluence to manage and distribute documentation, they need to be able to create tabular data, too. But Confluence is a collaboration platform and wiki, and wasn’t specifically built to handle complex tables or manage spreadsheet calculations. So can it be used to build, manage, style and calculate tabular content with ease?