Developer Docs: Using Antora to Create a Unified Output with Content from Different Repos

Photo by imeenhae on Pexels.com Some weeks ago, I joined an exciting new project at my company, where dozens of development teams and stakeholders collaborate to leverage AIOps, DevOps and ValueOps data to help our customers make better business decisions. In this project, I'm responsible for the end-user documentation and also for designing a content … Continue reading Developer Docs: Using Antora to Create a Unified Output with Content from Different Repos

How to Help Development Teams Write Better Tutorials

Photo by fauxels on Pexels.com One of the ways I support my development teams is by curating the internal documentation they create to on-board new members. Developers don’t always make the best writers (and I say “not always”, because in my career I’ve had the opportunity to work with excellent developers that are also highly … Continue reading How to Help Development Teams Write Better Tutorials

Project Management for Technical Writing: Structuring the Content and Organizing Tasks Logically

Photo by Startup Stock Photos on Pexels.com In the third post related to the Udemy Course I'm taking on Project Management for Technical Writers, I'll explain in my own words a strategy introduced in one of the modules, aimed at structuring content and organizing tasks logically using mind-mapping tools. Note: You may want to read … Continue reading Project Management for Technical Writing: Structuring the Content and Organizing Tasks Logically

Data Analytics, IoT, Big Data and ML – an Overview

Photo by Pixabay on Pexels.com I've recently started a new course about Data Science offered to my company and created by different authors on Pluralsight. The course consists of 23 modules which range from basics of data driven business to data science, AI and ML fundamentals, data visualizations, communications, and statistics foundations. Today I've finished … Continue reading Data Analytics, IoT, Big Data and ML – an Overview

Project Management for Technical Writing – Planning to Manage a Documentation Project

Photo by Karolina Grabowska on Pexels.com Note: This post summarizes some lessons learned from a course I'm currently taking about managing complex projects for technical documentation. It also includes my personal views and ideas. The Project Management Institute divides the large field of project management into 10 more digestible parts, which are known as the … Continue reading Project Management for Technical Writing – Planning to Manage a Documentation Project

Project Management for Technical Writing – Defining a Documentation Plan

I've recently started to work on a new project with a very complex structure, involving different teams, products and technologies. To make sure that I can deal with this complexity and deliver the best quality for the product documentation, I've decided to sign up to a course on Udemy to learn how to manage complex … Continue reading Project Management for Technical Writing – Defining a Documentation Plan

How to Create Taxonomies for Technical Documentation

Photo by Vitaly Vlasov on Pexels.com On my quest for best practices for taxonomies I‘ve come across an insightful webinar on this topic hosted on BrightTALk and conducted by Scott Abel (the Content Wrangler) and Heather Hedden. Heather is a taxonomy consultant for intranets, enterprise content management, SharePoint, research databases, websites, e-commerce, etc. I‘ve summarized … Continue reading How to Create Taxonomies for Technical Documentation

Providing Content Recommendations to Improve UX

Photo by Huu1ef3nh u0110u1ea1t on Pexels.com I'm currently researching different ways to provide content recommendations to the users of our technical documentation. Content recommendations can dramatically improve the user experience of our readers, especially when it comes to guides containing hundreds and even thousands of topics. Because let's be honest, nobody wants to read a … Continue reading Providing Content Recommendations to Improve UX

MadCap Flare Tricks: Using Variables in your CSS

MadCap Flare (v 2019) now supports the use of variables (also known as custom properties) in the css. This is a great enhancement, as it allows users to keep their documentation look-and-feel consistent. It also saves time, since you can use an attribute variable in several styles and define it only once (in the root … Continue reading MadCap Flare Tricks: Using Variables in your CSS

Adding JS to DITA files

Photo by Markus Spiske on Pexels.com This week I've been doing some research on how to make JS scripts work with DITA-based topics in the XML documentation plug-in for Adobe Experience Manager. While defining the scope of my research, I identified three possible approaches: Directly embed the script (and eventually, the accompanying CSS styles) into … Continue reading Adding JS to DITA files