(+39) 335 707 8284 [email protected]

Writing a style guide

by | Manuals, Methodology

Most successful companies have one or more style guides, which may cover the use of logos and trademarks, the design of corporate communications, the layout and graphics of a presentation, or the writing of a manual.. To qualify and harmonize software applications, there are also style guides for user interface design.

All are important documents. They set the tone for how a company is perceived in its public communications and products.

Style guide for documentation

A documentation style guide is a set of rules for writing, formatting, and structuring documents. The implementation of such a guide ensures the consistency of an organization’s documents. A style guide then serves as a reference point. This is not a matter of pure grammar or “right” or “wrong” style, but of providing guidance in a field where there are several ways to express concepts, and it is good to choose one consciously. In the absence of a clear common policy, it is not uncommon to see noticeable and even embarrassing differences in style by the time documents reach customers.

Style guides also provide a way to present a brand consistently, with the same tone and language register, especially when many authors are involved. They also save time and resources by providing immediate answers to often recurring doubts and questions, as well as a critical reference for training new employees.

What does a style guide contain?

Below are some guidelines for what a style guide should contain.

  • Vocabulary guidelines: should include a list of recommended technical terms (and prohibited alternatives), terms not to be translated, then terms to be avoided because they are potentially offensive, and clichés and expressions to be avoided.
  • Grammar recommendations: includes using the active or passive voice, personal or impersonal, and gendered references.
  • Stylistic rules for formats and usages: date (based on language), time, names, numbers, capital letters, bold, italic, underlined, bulleted and numbered lists, punctuation (quotation marks, exclamation marks, parentheses, semicolons), software code, and links/hyperlinks.
  • Intranet and Internet: filename conventions, keywords, tags, and SEO guidelines.
  • Logo: Rules for using and placing, dimensions, colors, background, as well as examples of uses and prohibited uses.
  • Tools and templates: rules for using text and graphics programs, templates for manuals, presentations and notes, with related structural rules.

Standards and reference guides

For English, the style guides of some major software companies are public and can be a useful reference, such as Apple, IBM e Microsoft.

Various standards also exist for technical writing in different languages.

These references can help simplify writing a long list of customized rules. But keep in mind that their generality makes them difficult to apply in their entirety to all contexts. They generally need to be “filtered” to get a good result and make sense to use in daily practice.

Integration into development tools

Some programs for modular and structured documentation development also include some programmable settings for implementing style rules directly online. Whenever possible, this approach should be preferred. It allows for quick and easy compliance checks during the editorial process.

Collaboration

Finally, as with all rules to be followed, it is important to remember that the creation of a style guide is a collaborative process that must mature collectively throughout the organization in order to be used with conviction and produce the expected results.

If you do not yet have the Style Guide and this is a topic that might be of interest to you, please contact us for a free, in-depth discussion.

Experience the Power of AI: A Practical Guide to Implementing a Successful Business Chatbot
Introduction Adopting a business chatbot that can provide fast, multilingual access to technical documentation through a conversational interface is an innovative strategy. This approach optimizes operational efficiency and improves information management within the...
Modular Content in Business Communication

Modular content is an innovative strategy for content management and creation. It consists of breaking down complex content into reusable modules that can be combined to create effective and engaging customer experiences. These modules, like building blocks, provide efficiency, flexibility, customization, and SEO optimization where needed.

Multi-language Virtual Assistant
Innovation for your business: Multilingual Virtual Assistant Find out how you can simplify access to information and improve support for your customers with our multilingual virtual assistant. Why Choose Our Virtual Assistant? Gets instant access to the information in...
Business growth strategy with high-quality technical content

A recent report details nearly 100 million user sessions in 136 countries, providing a comprehensive picture of user behavior around technical content. The results underscore the critical importance of delivering high-quality, well-structured content to capture interest, support customers and employees, and drive efficient and automated usage that results in significant operational savings.

Chatbot for accessing company documentation
Wouldn't you like to have a virtual assistant that can instantly locate a piece of documentation data by asking a simple question, even verbally? For example, to solve urgent problems or find information about products or services scattered in multiple documents. And...
Cybersecurity Guides

Today, it is essential to have a cybersecurity strategy and proper documentation. In this situation, having professional expertise is beneficial for creating new documents using robust, tested templates and for understanding how to utilize the right tools to manage all the sensitive technical information effectively.

Online Help for Software applications

The Online Help system is the user guide that is instantly available for user assistance. The software application looks serious and trustworthy, builds trust, gives users full autonomy, and reduces support calls.

API documentation

Investing in API documentation allows vendors to provide the best experience for customers who demand ease of use and therefore complete and accurate documentation. Click here to learn more about how a technical writer can make a difference.

Structured documentation with CCMS

Modern tools for developing documentation exist to ensure an optimized and structured approach, resulting in improved quality and reduced costs. What are they? Find out here.

Writing to communicate value

How to write well to reduce support requests, complaints, risk of damage, and malfunctions? And to be able to improve image and reduce the costs of training and supporting?

Operation and Maintenance Manuals

What should be included in a good operating and maintaining manual? How should it be structured to ensure that its goals are adequately addressed? Did you know that there is an international standard to which you should refer?

ChatBots and artificial intelligence: writing today for tomorrow’s applications

Writing today with the new tools of artificial intelligence in mind is timely and forward-looking, and immediately improves the quality of classic manuals.

Discover our services

We can offer you consultancy, training, digitalisation…

Do you need more information?

Briefly describe your needs, we will respond shortly with the most suitable solution or service.

Share This
Avvia chat
Ciao 👋
Come possiamo aiutarti?