{"id":10393,"date":"2024-03-14T17:01:15","date_gmt":"2024-03-14T11:31:15","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=10393"},"modified":"2025-02-13T09:01:21","modified_gmt":"2025-02-13T03:31:21","slug":"technical-writing-for-the-financial-industry","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/technical-writing-for-the-financial-industry\/","title":{"rendered":"Technical Writing for the Financial Industry"},"content":{"rendered":"<p><span style=\"font-weight: 400;\">As an art and an industry, technical writing has donned various hats and shapes. It evolved from a \u2018communication device to accomplish a task\u2019 to a fleshed-out, fully-fledged machine supporting countless niches and complexities of the world.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">It matters even more in the financial realm.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Money defines our decisions, and vice versa, in big and small hands alike. When you double it tenfold, big institutions and mammoth industries overhaul millions of transactions at the speed of light. For instance, Razorpay, one of the largest FinTech players in India, processed a Total Payment Volume (TPV) of $150 Billion in 2023.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">A lot matters in enabling these transactions. Technical communication is one of the pillars that upholds product and business trust. It augments users&#8217; understanding and usage of the products and services through transparency and accessibility.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">There is, however, a lot more than what meets the eye. In this blog, let us deep dive into the role of technical writing in the financial industry and the many ways it has come to shape.<\/span><\/p>\n<h3>The Early Days<\/h3>\n<p><span style=\"font-weight: 400;\">The online literature for the early days of technical writing is very sparse. <\/span><a href=\"https:\/\/razorpay.com\/learn\/evolution-in-technical-writing\/\"><span style=\"font-weight: 400;\">Its evolution is an interesting story<\/span><\/a><span style=\"font-weight: 400;\">, but technical documentation efforts in fintech get buried amongst the industry&#8217;s regulations and compliance changes. Documentation is deeply integrated into these developments.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">As such, my references for the article are a combination of online research and our latest <\/span><a href=\"https:\/\/www.linkedin.com\/feed\/update\/urn:li:activity:7160866239274184704\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">TalkX episode<\/span><\/a><span style=\"font-weight: 400;\"> that delved into how financial tech writing came about.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">In finance, most discussions revolve around exchanging money and goods, as well as related communication and information. Sometimes, they aim to bring awareness towards a better deal or highlight a recommended process. Other times, it\u2019s for standardising processes for an organisation, decision-making and documenting, or raising capital via stocks.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Finance has evolved dramatically, and agents of such communication, whom we now know as technical writers have huddled around these changes and grown simultaneously.<\/span><\/p>\n<figure id=\"attachment_10395\" aria-describedby=\"caption-attachment-10395\" style=\"width: 1836px\" class=\"wp-caption aligncenter\"><img decoding=\"async\" class=\"wp-image-10395 size-full\" src=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM.png\" alt=\"Image depicting financial transactions in real time\" width=\"1836\" height=\"1232\" srcset=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM.png 1836w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM-300x201.png 300w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM-1024x687.png 1024w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM-1536x1031.png 1536w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.51.54-PM-270x180.png 270w\" sizes=\"(max-width: 1836px) 100vw, 1836px\" \/><figcaption id=\"caption-attachment-10395\" class=\"wp-caption-text\">Financial technology grew from fax machines to software applications in just three decades.<\/figcaption><\/figure>\n<p><span style=\"font-weight: 400;\">This became apparent with the advent of the telegraph and fax machines. By the 90s, technical writers were not only subject-matter experts anymore but also the primary proponents of these machines. Consider the following questions:<\/span><\/p>\n<blockquote><p><span style=\"font-weight: 400;\">How did you use these machines? What format does a fellow follow to depict a Balance Sheet? What program connects the mainframe computer to the back-end operations? How do the complex banking and financial systems like SWIFT, ATMs, and more work?<\/span><\/p><\/blockquote>\n<h3><b>The Unique Case of Tech Writing in Financial Industry<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">There is one unique thing that separates tech writing from most industries when it is applied to the financial industry. Gopalakrishnan Tharoor, a persevering technical writing veteran from our latest TalkX session, elaborates that to navigate these waters\u2014where financial information has grown complex and outsourcing avenues quickly gained speed in the 90s\u2014 \u2018focus\u2019 had to join hands with systems.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">\u201cFin-tech prizes focus,\u201d began. He gave us a glimpse of <\/span><a href=\"https:\/\/en.wikipedia.org\/wiki\/Capability_Maturity_Model_Integration\" target=\"_blank\" rel=\"noopener\"><span style=\"font-weight: 400;\">CMMI guidelines<\/span><\/a><span style=\"font-weight: 400;\"> strictly adhered to in 80-page printouts, finally to be presented to the project managers. These were detailed protocols, annual reports, prospectuses, white papers, and more for a renowned bank. They fall at the mercy of intense rework should any information be more or less necessary.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">As you can imagine, these were all boringly lengthy and taxing. Where outsourcing was accumulating the spotlight, a single-minded focus had to shake hands with collaboration; he emphasised, \u201cTo prioritise the focus, you need systems. Well-oiled systems make or break documentation.\u201d<\/span><\/p>\n<h4><b>Importance of Systems<\/b><\/h4>\n<p><span style=\"font-weight: 400;\">For focus to remain at the centre of the venture, participants in the financial operations process must be immune to structural challenges, which was only possible with systemic efforts and strict protocols.\u00a0<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Systems are an antidote to the dynamic financial landscape.\u00a0<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Systems enforce discipline. Writers strictly adhere to writing protocol and collaboration processes to facilitate the smooth making of changes to the documentation.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">Systems empower accuracy, transparency, and literacy.<\/span><\/li>\n<\/ul>\n<p><span style=\"font-weight: 400;\">It made sense. We are talking of an era before the omnipresent internet, where collaboration, communication, management and more happened without modern software tools. Remove any cog from this wheel, and you get documentation that is a dead man\u2019s dream\u2014non-existent, inefficient and wasteful.<\/span><\/p>\n<figure id=\"attachment_10396\" aria-describedby=\"caption-attachment-10396\" style=\"width: 1718px\" class=\"wp-caption aligncenter\"><img decoding=\"async\" class=\"size-full wp-image-10396\" src=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.57.25-PM.png\" alt=\"Image depicting taxes and financials\" width=\"1718\" height=\"1270\" srcset=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.57.25-PM.png 1718w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.57.25-PM-300x222.png 300w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.57.25-PM-1024x757.png 1024w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.57.25-PM-1536x1135.png 1536w\" sizes=\"(max-width: 1718px) 100vw, 1718px\" \/><figcaption id=\"caption-attachment-10396\" class=\"wp-caption-text\">Tech writing aims to simplify information. It matters even more in the fintech industry to reduce barriers to information.<br \/>Image from Kelly Sikkema, Unsplash.<\/figcaption><\/figure>\n<h4><b>Balanced Writing<\/b><\/h4>\n<p><span style=\"font-weight: 400;\">Another unique component that redefines financial tech writing is the distinctive balance it strikes between expert and novice writing. What does that mean?\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Money matters are overwhelmingly universal. Every single person and institution deals with money in some structure. It is unlike most industries that more often than not, cater heavily to an audience of subject-matter experts. Think medicine, engineering, aeronautics and more.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Indeed, within money matters, different organisations exist for various monetary use cases. These included stock brokers and <a href=\"https:\/\/razorpay.com\/payment-gateway\/\">payment gateways<\/a>, who perform fundamentally monetary but functionally different work.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">But, the profile of a financial product user cannot be classified so easily. Yes, <\/span><a href=\"https:\/\/razorpay.com\/learn\/guide-to-audience-research-tech-writing\/\"><span style=\"font-weight: 400;\">audience research<\/span><\/a><span style=\"font-weight: 400;\"> helps, but the lack of context <\/span><a href=\"https:\/\/razorpay.com\/learn\/technical-writing-for-a-non-technical-audience\/\"><span style=\"font-weight: 400;\">for a non-technical audience<\/span><\/a><span style=\"font-weight: 400;\"> can easily deter and discourage the users.\u00a0 Most customers tend to have an idea. But how do we elevate users <\/span><i><span style=\"font-weight: 400;\">from<\/span><\/i><span style=\"font-weight: 400;\"> awareness <\/span><i><span style=\"font-weight: 400;\">to<\/span><\/i><span style=\"font-weight: 400;\"> literacy? That is a challenge unique to the financial industry. <\/span><\/p>\n<p><span style=\"font-weight: 400;\">Tech writers tackle this interesting challenge: to explain the structure of the information and contextualise that structure simultaneously. A great example is how we developed documentation for rather approachable, merchant-facing products\/topics like <\/span><span style=\"font-weight: 400;\">Payment Gateway<\/span><span style=\"font-weight: 400;\">, Subscriptions, and more, in contrast to <\/span><a href=\"https:\/\/razorpay.com\/learn\/4-mistakes-to-avoid-in-integration-guide\/\"><span style=\"font-weight: 400;\">developer-friendly API\/Integration documentation<\/span><\/a><span style=\"font-weight: 400;\">.<\/span><\/p>\n<h3><b>Prioritising Documentation<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">We have seen that technical writing has grown alongside financial products and the tools to use such products. But why did we even need documentation for that?<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Consider Razorpay, for example. We help businesses accept payments in a B2B or D2C space. But we also provide Source to Pay options to manage money, control outflow and categorise it. Then, there are credit products such as <\/span><a href=\"https:\/\/razorpay.com\/docs\/x\/capital\/line-of-credit\/\"><span style=\"font-weight: 400;\">Razorpay Line of Credit<\/span><\/a><span style=\"font-weight: 400;\"> and <\/span><a href=\"https:\/\/razorpay.com\/docs\/x\/capital\/corporate-cards\/\"><span style=\"font-weight: 400;\">RazorpayX Corporate Cards<\/span><\/a><span style=\"font-weight: 400;\">.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">You can notice the product suite is almost endless. Is there any indiscriminate common ground for both a beginner and the biggest corporations to start from? Yes. <\/span><a href=\"https:\/\/razorpay.com\/docs\/\"><span style=\"font-weight: 400;\">Razorpay Docs<\/span><\/a><span style=\"font-weight: 400;\">.<\/span><\/p>\n<figure id=\"attachment_10397\" aria-describedby=\"caption-attachment-10397\" style=\"width: 1906px\" class=\"wp-caption aligncenter\"><img decoding=\"async\" class=\"size-full wp-image-10397\" src=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.52.25-PM.png\" alt=\"Image showing the home page of RazorpayX Documentation\" width=\"1906\" height=\"1128\" srcset=\"https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.52.25-PM.png 1906w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.52.25-PM-300x178.png 300w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.52.25-PM-1024x606.png 1024w, https:\/\/d6xcmfyh68wv8.cloudfront.net\/learn-content\/uploads\/2024\/03\/Screenshot-2024-03-14-at-4.52.25-PM-1536x909.png 1536w\" sizes=\"(max-width: 1906px) 100vw, 1906px\" \/><figcaption id=\"caption-attachment-10397\" class=\"wp-caption-text\">Overview of our publicly available docs platform. Shown above is the documentation for RazorpayX\u2013the business banking suite.<\/figcaption><\/figure>\n<p><span style=\"font-weight: 400;\">Besides being a starting point, documentation broadcasts easy-to-consume, transparent product information to the users at the get-go, very stylishly and in <\/span><a href=\"https:\/\/razorpay.com\/learn\/accessibility-in-technical-writing\/\"><span style=\"font-weight: 400;\">an accessible manner<\/span><\/a><span style=\"font-weight: 400;\">.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">What else does it do?<\/span><\/p>\n<h4><b>Create Awareness<\/b><\/h4>\n<blockquote><p><span style=\"font-weight: 300;\">\u201cDocumentation gives you more information. Clear and structured information,\u201d Raghuram Pandurangan, a Senior Tech Writing Manager at PayU, said during TalkX. He went to great lengths to uncover tech writing\u2019s innate ability to market efficient product use. <\/span><\/p><\/blockquote>\n<p><span style=\"font-weight: 400;\">\u201cThere are multiple Payment Gateway integration types, each with specific benefits. Having documentation that lists down everything\u2014process, steps, use cases, errors and more\u2014it gives a clearer picture of the process to the end consumer and enforces better decision making.\u201d<\/span><\/p>\n<h4><b>Enable Financial Literacy<\/b><\/h4>\n<p><span style=\"font-weight: 400;\">Remember that fact about moving users from mere awareness to product literacy?<\/span><\/p>\n<blockquote><p><span style=\"font-weight: 300;\">Vinita Jagannathan, Lead Technical Writer with Razorpay, mentioned during the TalkX episode that, \u201cThe financial domain is vast. We cannot know who is coming to the documentation site for what reason and with what expertise.<\/span><\/p><\/blockquote>\n<p><span style=\"font-weight: 400;\">\u201cSo knowing this fact\u2014that we will have users arrive at the Docs platform with very limited knowledge\u2014 enhances the tech writers\u2019 personal expertise and ethos. It forces us to consider our role and responsibility to present information that welcomes all users. And we welcome them to communicate the end goal\u2014here is how you can successfully complete the integration.\u201d<\/span><\/p>\n<p><span style=\"font-weight: 400;\">That is one aspect of creating literacy. Vinita goes on to also highlight how it educates users on the best practices using the documentation site. \u201cBe it security or legal awareness that supports a product\u2014we highlight most of it on our docs. <\/span><i><span style=\"font-weight: 400;\">That<\/span><\/i><span style=\"font-weight: 400;\"> is what creates strong documentation and enhances product literacy.\u201d<\/span><\/p>\n<p><span style=\"font-weight: 400;\">And it applies not only to the kind of information presented. It also matters <\/span><i><span style=\"font-weight: 400;\">how<\/span><\/i><span style=\"font-weight: 400;\"> you are presenting this information. \u201cWe use screenshots and videos, gifs, diagrams, checklists, best practices guides and much more on the documentation. All of these are the various ways we present information for the users to consume, ensuring it is accessible,\u201d she added.<\/span><\/p>\n<h4><b>Precise Precision<\/b><\/h4>\n<p><span style=\"font-weight: 400;\">However, all those efforts are in vain if the documentation does not have up-to-date and precise information. Exactness, correctness and accuracy are critical in fintech.\u00a0<\/span><\/p>\n<blockquote><p><span style=\"font-weight: 300;\">\u201cYou cannot have a developer come to the APIs and find inconsistencies or wrong information. These are money matters,\u201d Vinita explained.\u00a0<\/span><\/p><\/blockquote>\n<p><span style=\"font-weight: 400;\">Lack of accuracy is costly to all the parties involved. It unnecessarily lengthens the resolution processes and provides a poor user experience.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Raghuram highlights a critical aspect of documentation here: collecting feedback. \u201cTo keep information precise and absolute, we must round up the latest news, deep dive and research to bring out the most accurate information.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">\u201cBut once it is out there, we must also have ways to correct the documentation if more information is available to add. We can do this by collecting feedback.\u201d<\/span><\/p>\n<h4><b>Security and Compliance <\/b><\/h4>\n<p><span style=\"font-weight: 400;\">The greatest challenge of them all is to share secure and compliant information that is up-to-date. Financial technology is largely digital now, which poses a great security risk to the information in transit. Data leaks, cyber frauds, phishing, and scams are all possible, with even the most minute access to the most vulnerable information. Exploitation knows no bounds.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Consider the example where a screenshot or a video that shows an active phone number belonging to a person is publicly available. If we do not care to hide such sensitive information, it can very easily be misused. The same goes for financial information like bank accounts or <a href=\"https:\/\/razorpay.com\/learn\/what-is-virtual-payment-address-vpa\/\">VPA<\/a>\/UPI details. This is why most screenshots, files and videos you see on docs are masked or contain imaginary numbers.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Another aspect of security in documentation is to provide users with the security certificates binding the organisation. All certifications\u2014<a href=\"https:\/\/razorpay.com\/blog\/what-is-pci-dss-compliance\/\">PCI DSS<\/a>, SOC and ISO, and encryption and authentication- must be publicly available so that users can be aware and exercise their rights.<\/span><\/p>\n<h3><b>In Conclusion<\/b><\/h3>\n<p><span style=\"font-weight: 400;\">These are insights into creating world-class documentation in the financial industry and what goes on in technical writers\u2019 minds when we think of documentation. There are other aspects towards documentation, and we\u2019ve covered only one part of the mammoth industry: FinTech.\u00a0<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Yet, no matter which area of FinTech we venture into, these principles remain intact: accessible, accurate and contextual documentation. <\/span><\/p>\n","protected":false},"excerpt":{"rendered":"<p>As an art and an industry, technical writing has donned various hats and shapes. It evolved from a \u2018communication device to accomplish a task\u2019 to a fleshed-out, fully-fledged machine supporting countless niches and complexities of the world. It matters even more in the financial realm. Money defines our decisions, and vice versa, in big and<\/p>\n","protected":false},"author":151156578,"featured_media":10394,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3606,1],"tags":[],"class_list":{"0":"post-10393","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-tech-writing","8":"category-uncategorized"},"_links":{"self":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/10393","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=10393"}],"version-history":[{"count":5,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/10393\/revisions"}],"predecessor-version":[{"id":15760,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/10393\/revisions\/15760"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media\/10394"}],"wp:attachment":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media?parent=10393"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/categories?post=10393"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/tags?post=10393"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}