githubEdit

Creating a voice

This guide shows how to shape your writing voice depending on context—whether you're writing a quick update, a concise summary, or a more detailed announcement. It follows a practical, task-oriented approach: each section is framed as a question you can ask yourself while writing.

What is the purpose of this communication?

Before writing anything, decide what the message needs to achieve.

  • Is it meant to inform quickly?

  • Is it meant to summarize changes?

  • Is it meant to explain and persuade?

Your answer determines the level of detail and tone.

Examples:

  • Quick update: "New feature available"

  • Summary: "Version update with new feature and improvements"

  • Detailed announcement: "Introducing a new feature that improves how users complete tasks"

Who is this for and how much do they need to know?

Adjust your voice based on how familiar the audience is with the topic.

Ask yourself:

  • Do they just need awareness?

  • Do they need enough detail to act?

  • Do they need full context to understand impact?

Examples:

  • Broad audience: "You can now export data more easily"

  • More experienced users: "Data export now supports multiple formats and batch processing"

How short should this be?

Different formats require different levels of compression.

Ultra-short (digest style)

  • One line

  • Focus on keywords and outcomes

  • No explanations

Example:

  • "New dashboard, performance improvements, and bug fixes"

Short (update/feed style)

  • 1–3 sentences

  • What changed + what it does

  • Optional benefit

Example:

  • "You can now export data in multiple formats. This makes it easier to reuse and share reports."

Extended (announcement style)

  • Multiple sentences or a short paragraph

  • What + how + why

  • Clear benefit

Example:

  • "We’ve introduced a new export feature that supports multiple formats and batch processing. This allows users to generate and reuse reports more efficiently, reducing manual work."

What is the core message?

Every entry should have a single clear idea.

Ask yourself:

  • If someone reads only one sentence, what should they remember?

Avoid mixing multiple unrelated ideas in one statement.

Example:

Instead of:

  • "New export feature and performance improvements and UI updates"

Prefer:

  • "New export feature available"

  • "Performance improvements across the system"

  • "User interface updates for better usability"

What details are worth including?

Include only details that help the reader understand or act.

Avoid:

  • Internal terminology

  • Configuration specifics

  • Implementation details

Prefer:

  • Visible changes

  • User-facing behavior

  • Outcomes

Examples:

  • Too technical: "Updated configuration values for processing pipeline"

  • Better: "Improved processing speed for large datasets"

How do I structure a slightly longer message?

Use a simple progression when more detail is needed:

  1. What changed

  2. What it does

  3. Why it matters

Example:

  • "A new notification system is now available. It allows users to receive alerts based on their activity. This helps users stay informed without manually checking updates."

How do I keep language consistent?

Consistency builds trust and readability.

Guidelines:

  • Use the same names for features or elements throughout

  • Avoid synonyms for the same concept

  • Keep capitalization consistent

Examples:

  • Always: "Dashboard"

  • Not: "Dashboard", "panel", "overview screen" (mixed usage)

How do I phrase benefits correctly?

Focus on outcomes, not implementation.

Ask:

  • What does this help the user do better?

Examples:

  • Weak: "Added new configuration options"

  • Strong: "Gives users more control over how data is displayed"

How do I avoid over-explaining?

Especially in shorter formats, clarity comes from restraint.

Remove:

  • Explanations of obvious concepts

  • Repeated ideas

  • Long lists of details

Example:

  • Too long: "Users can now click a button to export data into a downloadable file that can be opened in other tools"

  • Better: "Users can now export data for use in other tools"

How do I group multiple changes?

When summarizing multiple items:

  • Group similar changes together

  • Use simple separators (commas or semicolons)

  • Keep phrasing parallel

Example:

  • "New reporting tools; improved performance; usability enhancements"

How do I know if the tone is right?

Check your draft against these questions:

  • Is it clear without additional context?

  • Is it as short as possible for its purpose?

  • Does it focus on what matters to the reader?

  • Is it consistent with other entries?

If yes, the voice is aligned.

Quick reference: choosing the right style

Digest (one line)

  • "New reporting tools; performance improvements; usability updates"

Short update

  • "New reporting tools are now available. They make it easier to analyze and share data."

Extended announcement

  • "We’ve introduced new reporting tools that make it easier to analyze and share data. These updates improve usability and reduce the time needed to generate insights."

By consistently asking these questions, you can adapt your voice to any format while keeping clarity, consistency, and usefulness.

Last updated