Style guidelines for UX writing

2021-2024

Context

Prior to the new platform, Technical Communications did not have a clearly documented UX writing guide. As we were writing the UI text for the new solutions, we quickly realized that we needed to document our styles.

First draft

The other senior UI writer and I started a Confluence page where we documented all of our decisions. As we were making these decisions, we thoroughly researched competitor’s UX writing style guides to determine which best practices we should follow.

Formal style guide

When we began writing the design system guide, I transitioned that decision wiki to a more formal style guide. Based on the competitors we researched, I finalized this style guide for both internal and external use, which included extensive examples. I continue to update this guide as writers find new patterns we haven’t defined yet.

Skills

Project management, informal competitive analysis, UX writing, style guide writing, developing useful examples, applying feedback, working within regulated industries, writing and designing for B2B audiences

Tools

MadCap Flare, Confluence, Jira, Adobe XD, Figma, enterprise software

Previous
Previous

UX writing

Next
Next

API writing