{"id":8664,"date":"2023-08-18T16:36:37","date_gmt":"2023-08-18T11:06:37","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=8664"},"modified":"2024-10-14T16:29:25","modified_gmt":"2024-10-14T10:59:25","slug":"the-importance-of-a-glossary","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/the-importance-of-a-glossary\/","title":{"rendered":"The Importance of a Glossary"},"content":{"rendered":"<p><span style=\"font-weight: 400;\">Do you recall literature textbooks from your school days? Hefty and laden with discoveries? Across all language text books, one common thing was the chapter-end exercises, of course, but also the list of meanings right after the end of the lesson.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Such literature often contained complex, period-specific wording choices that spun our heads. So the meanings lists made the text accessible and easy to understand. They remained a steady, reliable source that helped me decipher the text with relative context and simplicity.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">As I grew older, I found such lists everywhere. Think of dictionaries, directories, end-notes, citations, and glossaries. Diverse as they are, they served a singular purpose:\u00a0<\/span><\/p>\n<p><i><span style=\"font-weight: 400;\">They were simple, concise, one-stop lists and acted as excellent references.\u00a0<\/span><\/i><\/p>\n<p><span style=\"font-weight: 400;\">In a documentation context, such lists are arranged as a glossary: a list of terminologies simplified using contextual explanations.<\/span><\/p>\n<h1><b>Does Anybody Read Glossaries?<\/b><\/h1>\n<p><span style=\"font-weight: 400;\">I\u2019ll admit: going through the meanings solely wasn\u2019t so fun. Glossaries are used less for reading and are more commonly used to take references and immediate help. When you notice an unfamiliar word, you try to remove that uncertainty with some help.\u00a0<\/span><\/p>\n<p><i><span style=\"font-weight: 400;\"><img decoding=\"async\" class=\"alignnone size-full wp-image-8665\" src=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.27.12-PM.png\" alt=\"\" width=\"1910\" height=\"1154\" srcset=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.27.12-PM.png 1910w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.27.12-PM-300x181.png 300w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.27.12-PM-1024x619.png 1024w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.27.12-PM-1536x928.png 1536w\" sizes=\"(max-width: 1910px) 100vw, 1910px\" \/>A vintage glossary page<\/span><\/i><\/p>\n<p><span style=\"font-weight: 400;\">Consider <\/span><a href=\"https:\/\/razorpay.com\/docs\/#home-payments\"><span style=\"font-weight: 400;\">Razorpay Docs<\/span><\/a><span style=\"font-weight: 400;\">, our documentation platform. We host countless articles and media about multiple Razorpay products, spanning across countries and industries, containing complex application and code integrations to industry-specific business finance management.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">The scope for technical jargon is vast. While we make our documentation accessible, it\u2019s critical to <\/span><a href=\"https:\/\/razorpay.com\/learn\/guide-to-audience-research-tech-writing\/\"><span style=\"font-weight: 400;\">balance the document&#8217;s intent with the audience<\/span><\/a><span style=\"font-weight: 400;\">. Even if we tried simplifying the language, we would still face problems. For example:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">\u2018Bookkeeping\u2019 is specific to accounting. Any mention may confuse the reader, but we cannot switch it to something simpler for non-accounting audiences.\u00a0<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Razorpay\u2019s products commonly use \u2018merchant\u2019 and \u2018businesses\u2019 interchangeably, although they may not mean the same thing as in a dictionary.\u00a0<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">\u2018Authorisation\u2019 can mean two different things when considering it for API or bank transfer authorisation.\u00a0<\/span><\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">So how do we bridge this gap? With a Glossary! Often users come across a foreign term but do not need a detailed process explanation at that moment. Glossaries fit this spot: they are brief and straightforward, offer the necessary information based on the context and provide timely help.\u00a0<\/span><\/p>\n<p><i><span style=\"font-weight: 400;\"><img decoding=\"async\" class=\"alignnone size-full wp-image-8666\" src=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM.png\" alt=\"\" width=\"2876\" height=\"1518\" srcset=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM.png 2876w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM-300x158.png 300w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM-1024x540.png 1024w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM-1536x811.png 1536w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2023\/08\/Screenshot-2023-08-18-at-4.30.17-PM-2048x1081.png 2048w\" sizes=\"(max-width: 2876px) 100vw, 2876px\" \/>Razorpay Docs Payments\u2019 glossary page<\/span><\/i><\/p>\n<h1><b>Why (Else) Glossaries?<\/b><\/h1>\n<p><span style=\"font-weight: 400;\">There is a strong business case, internally and externally, to adopt and maintain one or more glossaries.\u00a0<\/span><\/p>\n<h3><b>Creates Consistency<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">For both the organisation and the customer, a glossary ensures the standardisation of content and that we put out industry-par content. Bookkeeping means the same on any page of your documentation.<\/span><\/p>\n<h3><b>Effective Internal Collaboration\u00a0<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">Keeping the above point in mind, maintaining a glossary helps teams communicate better internally, externally and cross-functionally, due to its centralised nature.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Think of support functions that refer to the glossary while interacting with end users, and organisations that create company-specific glossaries for daily use. Glossaries are used to onboard new employees too.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">For example, \u2018Contact\u2019 within Razorpay refers to a business product within the banking suite. We maintain a glossary for internal and external teams to understand that Contact, in this context, is a product offering.\u00a0<\/span><\/p>\n<h3><b>Enhances Understanding\u00a0<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">Glossaries simplify complex terminology. Users find relevant and timely information that improves their understanding. As such, Glossary writers undertake thorough research to keep the content up-to-date.\u00a0<\/span><\/p>\n<h3><b>Improves Brand Image<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">All of the above points highlight how adding a glossary can make an organisation more accountable and thorough with its services. Such practices solidify reliability, which improves customers\u2019 trust in your services.\u00a0<\/span><\/p>\n<h1><b>How to Write a Glossary?<\/b><\/h1>\n<p><span style=\"font-weight: 400;\">Glossaries are fun to create. Whether we are creating a stand-alone glossary or multiple of them, some instructions we follow are:<\/span><b><\/b><\/p>\n<h5><b>Identify Terms<\/b><\/h5>\n<p><span style=\"font-weight: 400;\">We follow the following ways to identify a glossary term:\u00a0<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Common, recurring and relevant terms.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Frequency within the same document.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Frequency in multiple documents.<\/span><\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">First, glossaries must contain explanations for recurring and commonly used terminology. If your document uses an abbreviation or a term that repeats multiple times, consider defining it in the glossary. Providing universally accepted definitions of the industry-specific terms is wise.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Also, consider the frequency of these terms within the same document and outside of it. Some words continually appear within the document but are negligible outside that topic. A few others contribute significantly to explaining critical processes irrelevant to where they are originally used.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Say, for example, industry terms like <a href=\"https:\/\/razorpay.com\/learn\/neft\/\">NEFT<\/a>, <a href=\"https:\/\/razorpay.com\/learn\/rtgs\/\">RTGS<\/a>, and IMPS have found a place in the <a href=\"https:\/\/razorpay.com\/docs\/x\/glossary\/\">RazorpayX Glossary<\/a>. These terms are sparsely used but are critical to understanding RazorpayX\u2019s offerings.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Due to their contextual relevance over frequency, we have included them in the glossary, which makes the user journey seamless. They would need to refer to the glossary instead of having to put in the effort and Google their meanings. Glossaries present all relevant definitions in one place.<\/span><b><\/b><\/p>\n<h5><b>Create Style Guides<\/b><\/h5>\n<p><span style=\"font-weight: 400;\">By nature, glossaries are meant for reference rather than reading. Writers thus prioritise brevity and use simple but relevant terminology to define complex terms.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Undertake target audience research to develop a writing guide and adopt the technology and design to present that information.<\/span><b><\/b><\/p>\n<h5><b>Get Started<\/b><\/h5>\n<p><span style=\"font-weight: 400;\">Start creating a repository of definitions on your platform and interlink these definitions wherever they are used in the documents. This can be daunting to start from scratch, but it pays off.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Once you have built the glossary, you must also invest in maintaining it. Update and revise the glossary regularly to include every new feature or product the organisation rolls out and the changes in the industry. <\/span><b>FinTech,<\/b><span style=\"font-weight: 400;\"> which did not exist in the dictionaries a decade back, has become a buzzword and prominent in the current times.\u00a0<\/span><\/p>\n<h1><b>To Summarise<\/b><\/h1>\n<p><span style=\"font-weight: 400;\">Glossaries are an essential part of your content strategy. It makes your content easier to comprehend, consistent, and <\/span><a href=\"https:\/\/razorpay.com\/learn\/accessibility-in-technical-writing\/\"><span style=\"font-weight: 400;\">accessible<\/span><\/a><span style=\"font-weight: 400;\">. Users are looking for precise information, and a glossary brings the content creators and audiences on the same page.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Glossaries serve as a bridge between two ends, a perfect balance\u2014as are most things in life best enjoyed.<\/span><\/p>\n<p><b>References:<\/b><\/p>\n<ol>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/www.bridging-the-gap.com\/glossary\/\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">https:\/\/www.bridging-the-gap.com\/glossary\/<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/www.scribbr.com\/dissertation\/glossary-of-a-dissertation\/\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">https:\/\/www.scribbr.com\/dissertation\/glossary-of-a-dissertation\/<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/www.smartcat.com\/blog\/making-the-perfect-glossary\/\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">https:\/\/www.smartcat.com\/blog\/making-the-perfect-glossary\/<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/document360.com\/blog\/knowledge-management-business-glossary\/\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">https:\/\/document360.com\/blog\/knowledge-management-business-glossary\/<\/span><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><a href=\"https:\/\/www.sciencedirect.com\/science\/article\/abs\/pii\/S0955598602000584\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">https:\/\/www.sciencedirect.com\/science\/article\/abs\/pii\/S0955598602000584<\/span><\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>Do you recall literature textbooks from your school days? Hefty and laden with discoveries? Across all language text books, one common thing was the chapter-end exercises, of course, but also the list of meanings right after the end of the lesson. Such literature often contained complex, period-specific wording choices that spun our heads. So the<\/p>\n","protected":false},"author":151156578,"featured_media":8667,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3606],"tags":[3613],"class_list":{"0":"post-8664","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-tech-writing","8":"tag-technical-writing"},"_links":{"self":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/8664","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\/151156578"}],"replies":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/comments?post=8664"}],"version-history":[{"count":5,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/8664\/revisions"}],"predecessor-version":[{"id":14027,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/8664\/revisions\/14027"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media\/8667"}],"wp:attachment":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media?parent=8664"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/categories?post=8664"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/tags?post=8664"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}