{"id":9474,"date":"2023-11-17T16:41:29","date_gmt":"2023-11-17T11:11:29","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=9474"},"modified":"2023-11-17T16:42:04","modified_gmt":"2023-11-17T11:12:04","slug":"writing-for-international-audience","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/writing-for-international-audience\/","title":{"rendered":"Writing For International Audience"},"content":{"rendered":"

In the 1970s, the Chevrolet Nova was a popular car in the United States. It was known for its sleek lines, powerful engines, and a reputation for performance. However, despite all its features, it did not sell well in Spanish-speaking markets. Why? The name “Nova” was interpreted as “no va,” which in Spanish means “it doesn’t go”. This led to a perception that the car had performance issues, impacting sales. The company had to rename it Chevrolet Caribe to avoid the negative connotation associated with the original name.<\/span><\/p>\n

\"\"KFC, when it first entered the Chinese market in the 1980s, was embroiled in a similar controversy as the popular tagline – \u201cFinger Licking Good!\u201d translated to \u2018Eat Your Fingers Off\u2019!<\/span><\/p>\n

From the above examples, it can be understood that creating content for international audiences is tricky – be it brand names or promotional taglines. Or even, for that matter, technical documentation!<\/span><\/p>\n

In this blog, we explore the creation of technical documentation for an international audience.<\/span><\/p>\n

Content Translation vs Localisation<\/span><\/h3>\n

Translation<\/span><\/h4>\n

This is definitely the first thing that comes to mind, isn’t it? When expanding to another country and acquiring new users who may or may not speak English, do we translate the documentation?<\/span><\/p>\n

In the case of online help manuals, users can use browser settings to translate technical documentation themselves. However, as we learnt from the Chevy and KFC examples, word-to-word translation can cause confusion – be it brand names or tag lines.\u00a0<\/span><\/p>\n

This is true for procedural steps as well. For example, if we want to translate the English text \u2018Save Card Number\u2019 to Hindi, the word-to-word translation would be <\/span>\u0915\u093e\u0930\u094d\u0921 \u0928\u0902\u092c\u0930 \u092c\u091a\u093e\u090f\u0901. <\/span>The best way to write this instead would be \u0915\u093e\u0930\u094d\u0921 \u0928\u0902\u092c\u0930 \u0938\u0947\u0935 \u0915\u0930\u0947\u0902.\u00a0<\/span><\/p>\n

\"\"If organisations do not have internal content translation resources, they usually tackle this by working with external agencies specialising in such translation activities. This, however, comes at a price. Also, the translated content needs to be validated by another party before publishing to weed out any errors.\u00a0<\/span><\/p>\n

Localisation<\/span><\/h4>\n

Localisation goes beyond translation. It involves adapting the content to suit the cultural needs and conventions followed.<\/span><\/p>\n

For example, using the local currency, GBP, instead of INR would help international users in, say, Britain, to understand the content and implications better. Using placeholder names such as Nur Aisyah would resonate better with Malaysian users than the typical Jane Doe.<\/span><\/p>\n

\"\"US users would appreciate using the imperial system of measurement rather than the metric system.<\/span><\/p>\n

Content localisation can be extended to videos and images as well. However, this means additional cost and effort. Imagine there is a screenshot showing order placement on the website. For localisation, one may have to capture and maintain multiple screenshots for multiple regions just because the currency used is different – INR in India, EUR in Europe, SGD in Singapore and so on.<\/span><\/p>\n

Translation or Localisation?<\/span><\/h4>\n

Organisations may opt for either translation, localisation or a mix of both.<\/span><\/p>\n

That said, before diving into translation or localisation, ensure your documentation is <\/span>internationalised<\/b>. According to Google, internationalisation means designing a product and its associated documentation to minimise the localisation effort. This involves designing flexible content, allowing for easy adaptation to different languages and cultures. A well-internationalised document sets the stage for effective translation and localisation efforts.<\/span><\/p>\n

General Tips When Writing for Global Audience<\/span><\/h3>\n

Once we identify our documentation strategy, we can proceed with the authoring. Here are some tips to consider when writing for an international audience:<\/span><\/p>\n

Use Clear, Concise Language.<\/span><\/h5>\n

Write simple sentences in active voice. Avoid using complex sentences as they may be difficult to understand and harder to translate. Here is an example:<\/span><\/p>\n

Complex Sentence<\/strong>: <\/span>The firmware update process is initiated by the system upon detection of available updates, and the user is notified once the update is successfully completed.<\/span><\/p>\n

Simple Sentence<\/strong>: <\/span>The system initiates the firmware update process upon detecting available updates. It notifies the user after the completion of the update.<\/span><\/p>\n

Write Inclusive Documentation<\/span><\/h5>\n

Inclusive writing means creating content considering the wide range of users documentation should serve. For example, while many users might use the traditional keyboard-monitor-mouse set-up, there could be people using various input methods, including touch screens or assistive technologies. Here is a small example:<\/span><\/p>\n

Generic Writing<\/strong>: <\/span>“Click on the ‘Submit’ button to save your changes.”<\/span><\/p>\n

Inclusive Writing<\/strong>: <\/span>“Select the ‘Submit’ button below to save your changes.”<\/span><\/p>\n

One can also consider the terms \u201cwhitelist\u201d and \u201cblacklist\u201d. We can use allowlist and blocklist instead to convey the same message. Here is what <\/span>Google<\/span><\/a> has to say:<\/span><\/p>\n

Many non-inclusive terms are in wide use in the industry, such as <\/span>whitelist<\/span><\/i>. If replacing an established term could cause confusion for readers, you can directly refer to the non-inclusive term on the first use, and put it in parentheses. Then use the inclusive, replacement term throughout the rest of the document.<\/span><\/p><\/blockquote>\n

Example:<\/b><\/p>\n

To make sure that administrators get the notification, add them to an allowlist (sometimes called a whitelist). Anyone who isn’t on the allowlist is blocked \u2026<\/span><\/p>\n

Consider Creating Glossaries<\/span><\/h5>\n

A glossary is a central place to define and explain key terms and concepts used in your documentation. In internationalisation, a glossary can be an invaluable resource for translators, providing a clear reference for key terms and concepts. It aids in maintaining accuracy and consistency across different language versions. Read this blog to learn more about <\/span>writing glossaries<\/span><\/a>.<\/span><\/p>\n

Test the Documentation<\/span><\/h5>\n

It is very important to test the documentation before publishing it in different geographies. In case of translation\/localisation, share the documentation with native speakers\/users to get their feedback on the content.\u00a0<\/span><\/p>\n

How Razorpay Docs Scaled to Multinational Markets<\/span><\/h3>\n

At Razorpay, this year, we expanded to Malaysia and now serve Malaysian businesses. Check out our <\/span>Curlec docs<\/span><\/a> for inspiration on how Razorpay has built its docs to cater to Malaysia.<\/span><\/p>\n

\"\"What We Did<\/span><\/h4>\n
    \n
  • Adopted an internationalisation strategy for our product and documentation.\u00a0\u00a0<\/span><\/li>\n
  • Designed a Content Strategy to serve international markets with clarity on where to localise and how much to localise.<\/span><\/li>\n
  • Conducted feedback sessions with Malaysian developers to understand their perception of the documentation and have incorporated the learnings in our Docs.<\/span><\/li>\n
  • A continuous improvement process with scope to polish our Content Strategy as we have more findings and grow our business.<\/span><\/li>\n
  • \u00a0Concepts like single-sourcing to reuse content with the capability to create customised content for specific locations.<\/span><\/li>\n<\/ul>\n

    Conclusion<\/span><\/h3>\n

    When writing for a global audience, it is important to create content that is clear, comprehensible and crafted after careful consideration of language, culture and user expectations. Organisations planning to spread their wings to newer horizons should contemplate the use of best practices and strive to create content that is inclusive, user-friendly and enhances user satisfaction. The key is not to go overboard and consider Cost, Maintainability and Scalability with eyes on ROI while devising a strategy to cater to wider audiences.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

    In the 1970s, the Chevrolet Nova was a popular car in the United States. It was known for its sleek lines, powerful engines, and a reputation for performance. However, despite all its features, it did not sell well in Spanish-speaking markets. Why? The name “Nova” was interpreted as “no va,” which in Spanish means “it<\/p>\n","protected":false},"author":151156543,"featured_media":9470,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3606],"tags":[],"class_list":{"0":"post-9474","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-tech-writing"},"_links":{"self":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/9474","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/users\/151156543"}],"replies":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/comments?post=9474"}],"version-history":[{"count":1,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/9474\/revisions"}],"predecessor-version":[{"id":9475,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/9474\/revisions\/9475"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media\/9470"}],"wp:attachment":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media?parent=9474"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/categories?post=9474"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/tags?post=9474"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}