Matt Reiner, content strategist at NimbleUser, explains why he championed the transition from writing technical documentation in DITA to writing with Confluence and Scroll Versions in this guest blog post.
Posts tagged with Confluence
K15t proudly introduces Scroll ImageMap 2.0, a handy add-on that brings Confluence images to life with multiple clickable link areas and mouseover tooltip regions. With its intuitive graphic editor, ImageMap makes it easy to define circles, rectangles, or complex polygons as clickable regions, and make your Confluence images an engaging, informative experience.
Im Durchschnitt vergeudet ein Mitarbeiter 60 % des Tages mit unnötigen Aufgaben, ineffizienten Meetings und der Bearbeitung hunderter E-Mails. Dies belastet die Produktivität enorm. Es ist höchste Zeit für eine Veränderung.
Scroll Versions 3.0 is live in the Atlassian Marketplace, and it boasts a range of new features and functionality. Today, we'll examine some features that give you unprecedented control over your content management: version-based editing permissions, modular configuration. . .
Our most popular exporters just got a flexibility upgrade, allowing the exporting of Confluence content in two new ways: task list export in all Scroll Exporters, and table cell highlighting in Office.
A big thank-you goes out to all who joined us for the Scroll Versions 3.0 webinar. A complete video and all of the submitted questions and a...
Available now in the Atlassian Marketplace We're proud to announce Scroll Versions 3.0, a major release of the best version management tool ...
Atlassian Summit Survey Results Are In It's no secret that Confluence is a powerful platform for documentation collaboration. At Atlassian S...
“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.
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.
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.
Today, we’re going to settle the question once and for all – which is superior? Documentation in a plain-text editor using Markdown, or crea...
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.
The inline comments functionality allows users to review Confluence pages line by line and add comments on selected words, phrases, or entire paragraphs. Once you've added your feedback, you can resolve comments simply by clicking 'Resolve'.
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?
On December 16, James Turcotte, SVP, Business Unit Executive of CA Technologies, gave a presentation on how Computer Associates keeps product documentation updated and improves turn-over time. In this presentation, James coined the term DocOps, describing it as the sibling of DevOps. Support agents, developers and, of course, technical communicators cooperate to deliver value to the customer. They do this by continuously improving documentation and knowledge management, even after release. We are delighted that our very own Scroll Versions enabled them to manage their content in Confluence.
In our recent survey, we asked technical writers at the tcworld Conference how they manage documentation content, and how they collaborate with other communicators, developers, and experts. Here are the results – and some of them might surprise you.