Technical DocumentationHow to Create a Documentation Structure That Works for the Whole Team
Great documentation helps you build a base of happy, successful, and self-sufficient users. But how you choose to structure your content will have a big impact on both your users and the team members who write and contribute to the docs.
Now any team can quickly create a help center from Confluence using the new Help Center theme in Scroll Viewport. Create a custom help experience without writing code.
Extend what Scroll Versions and Scroll Translations can do for your team.
We're sharing a new guide for creating great documentation in Confluence using proven technical writing methods.
Ready to amplify your documentation experience? Here's some inspiration as you make your technical writing New Year's resolutions.
Check out the big changes in the technical writing industry and discover brand new solutions for better teamwork
The way we work is changing in almost every profession. But what does the future hold for the techcomm community? Read about the challenges the industry is facing and how a new focus on collaboration will change technical documentation for good.
Scroll Versions 3.11 introduces content reuse across versioned or translated spaces. Learn about the new Include Library and how to benefit from the updated Include+ macro.
Content reuse helps technical writers create high quality documentation faster and facilitates updates and translation of content. Learn why you need a content reuse strategy and how to get started using tools that Confluence offers out of the box.
Context-sensitive help offers users the help content they need, when and where they need it – and Confluence is the perfect platform for managing it.
The term 'data driven' is thrown into just about every best practice process one hears about these days. Thankfully it's more than just meaningless buzz – but what does it mean when applied to a self service portal such as a help center website? How does one decide what self service analytics to look at, and what conclusions to draw?
Tekom/TCWorld, the world's largest technical communication conference, wrapped up last week. Our resident tech writer Tom highlights a few points of interest.
Write the Docs Prague 2017 is a three-day conference where some of the brightest minds in techcomm get together and discuss the field's hottest topics. I picked up a bunch of handy tips at the event – here are some personal highlights.
In this post, I'll share five techniques our teams here at K15t have adopted to align the efforts of tech writers and marketers in support of one another. Together they constitute a light and fast approach to making changes that aren't big, difficult, or complicated. They're about teaching your old docs new tricks.
Tuesday's technical documentation conference in Munich featured many interesting topics – such as digitalization, connectivity, and creative writing – but two technologies really took center stage: virtual and augmented reality. Will they change the techcomm industry?
Nowadays, translators use software to make their daily work easier and it's quickly becoming obvious that a standardized file format is needed. XLIFF is an odds-on favorite for making translation files universally practical.
Writing high-quality content (no matter what type) is extremely difficult, but using automated content optimization can definitely help you tackle this challenge. I'd even go so far as to claim that optimization tools are part of a great writing process. Why? Read on to find out.
No one knows what the future of technical writing looks like. You can however get a pretty good idea if you have a look at the characteristics and philosophies of the people who are newly entering the profession. As a teacher of technical writers, I get to see generation Y in action all the time and perhaps my observations about their ideas and reactions to different editorial systems are an indicator of what is to come.
Tekom OpenLab 2017 – a one-day 'unconference' where techcomm enthusiasts meet to discuss the industry's hottest topics. And because sharing is caring, I'm excited to share some pointers I picked up in this short summary.
The gap between technical communicators and content marketers can be a daunting one, but the benefits realized by building the bridge makes it well worth the effort.
Giving images in a collaboration platform new life with interactivity can help all kinds of teams work better together – and we have three examples that prove it right here in our own office using Confluence and the Scroll ImageMap add-on.
Techcomm and content teams often have a dysfunctional relationship even though they have the potential to be more effective at achieving their goals by understanding and working together. In the first part of this four-part blog series I will explore the reasons for the gap between techcomm and content marketing teams.
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.
In Nov 2016, we asked our TC World Conference booth visitors how they think technical editorial departments and bordering departments work together. Who works together with whom and what is especially important to those involved?
Scroll Versions 3.3 for Confluence is live now on the Atlassian Marketplace. This major release of the popular version and variant management add-on features advanced Comala Workflows integration – letting you leverage powerful workflows to achieve great results even in complex versioned content projects.
K15t Software will have a big presence at tekom/tcworld once again – and this time we're announcing a groundbreaking new solution that lets teams doc better together. We'd love to meet you at our booth if you're headed to the show.
Managing controlled documents such as software specifications, plans, or collaboratively-edited contracts isn’t easy at the best of times. And it’s harder yet if multiple stakeholders from different organizations are involved: project managers, engineers, QA, legal etc. Thankfully, there is a better way. . .
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'.