Topics – The Technical Editor

Automating editorial standards and writing processes? Here’s the kind of training your writers will need

Training for writers in the context of automating editorial standards and writing processes is crucial for ensuring they effectively utilize tools, adhere to guidelines, and produce high-quality technical content. Here’s…

View Post

Planning to automate content standards and processes? Let’s talk about how-tos, challenges, training, and tools

When you automate editorial standards for a technical publications team, you need a strategic approach that ensures clear guidelines, appropriate tools, effective training, and proactive management of challenges. As a…

View Post

View Post

Google Developer Documentation Style Guide

While the Google Developer Documentation Style Guide contains editorial guidance for writers essentially documenting content oriented towards Google developers, we believe it contains practical advice suitable for most developer documentation.…

View Post

View Post

Wondering how to run usability tests on your documentation? Here’s a list of methods and the value-add

Technical documentation is crucial for ensuring that users can effectively find information, understand instructions, and achieve their goals when using a software product. You can use usability tests to evaluate…

View Post

View Post

Microsoft Writing Style Guide

The Microsoft Writing Style Guide (earlier known as Microsoft Style for Technical Publications) is perhaps one of the best known (if not one of the most comprehensive guidance) for technical publications available publicly.

View Post

View Post

XML or Markdown? What should you consider when making a decision?

XML-based authoring tools and Markdown-based authoring tools serve different purposes and cater to different user needs. XML (Extensible Markup Language) is a versatile markup language used for structuring, storing, and…

View Post

View Post

Acrolinx, Grammarly, or Congree? Here are the pros and cons

Editorial automation software such as Acrolinx, Grammarly, and Congree offer valuable features and capabilities for enhancing the quality, consistency, and efficiency of technical documentation. However, organizations should carefully evaluate their…

View Post

Content Strategy

Moving to peer reviews instead of editorial? Let’s talk about challenges and strategies

If you’re planning to make a strategic change in your documentation team to use peer reviews instead of editorial reviews, the transition can yield numerous benefits. However, it also entails…

View Post

Content Strategy

Moving your doc team from an editorial to a peer-review model? Here’s how!

While editorial reviews offer ultimate value in terms of standardized content quality, you might want to transition your documentation team to a peer review process for several strategic reasons. For…

View Post