{"id":7997,"date":"2023-05-24T13:52:05","date_gmt":"2023-05-24T08:22:05","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=7997"},"modified":"2023-05-31T14:11:18","modified_gmt":"2023-05-31T08:41:18","slug":"design-thinking-in-documentation","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/design-thinking-in-documentation\/","title":{"rendered":"Design Thinking in Documentation"},"content":{"rendered":"

Preamble<\/b><\/h1>\n

My first acquaintance with Razorpay Docs began when I joined Razorpay as a Tech Writing Intern. Back then, the platform on <\/span>razorpay.com\/docs<\/span><\/a> was much different than what you currently see. I remember quite liking it!\u00a0<\/span><\/p>\n

The docs then had a landing page with the products and subproducts lined up perfectly. The horizontal product line had lovely icons with characteristic colours, and the navigation within those pages was basic and sufficient. It was functional, easy enough and assisted me as much as I requested. I was content with my search and collected positive impressions from repeated but minimal Docs usage.\u00a0<\/span><\/p>\n

Which was why I was utterly bowled over when my manager, during the docs-introduction team-onboarding session, said:\u00a0<\/span><\/p>\n

As you see, the functionality of Docs could be better…<\/span><\/p><\/blockquote>\n

I simply blinked my eyes at the Zoom screen-share in confusion.\u00a0<\/span><\/p>\n

Design Thinking in Documentation<\/b><\/h1>\n

The notion of \u2018lack of functionality\u2019 is not a notion at all but a necessary metric to measure the usability of docs, qualitatively and quantitatively. Words like \u2018discoverability\u2019, \u2018user experience\u2019, and \u2018content-correctness\u2019 are used for the same reason.\u00a0<\/span><\/p>\n

They are core objectives of designing documentation, visually and structurally. These have evolved over the many years of feedback from interviews and responses woven with design principles.<\/span><\/p>\n

As for me, I did not realize all this back then. Nor did I know that the <\/span>current documentation style on Razorpay Docs<\/span><\/a>, which had existed as a V2 Docs Beta then, was part of a redesign project\u2014a revamp that was learning to meet such core objectives of documentation.\u00a0<\/span><\/p>\n

It resulted from design thinking\u2014a school of thought that I was yet to learn.<\/span><\/p>\n

What is Design Thinking<\/b><\/h2>\n

So what is design thinking? To put it simply, it is the process of see-learn-invent-implement.\u00a0<\/span><\/p>\n

In the documentation context, design thinking looks at how the user reads the documentation and intends to understand their pain points. Using those insights, it further develops, tests and implements possible solutions.<\/span><\/p>\n

The approach of design thinking is standardised in a lot of blogs and books through a few steps, which are:\u00a0<\/span><\/p>\n

    \n
  • Empathising with the users and identifying their problems<\/span><\/li>\n
  • Defining the hurdles the users have to overcome in their journey<\/span><\/li>\n
  • Brainstorming and coming up with the possible ideas<\/span><\/li>\n
  • Generating prototypes of ideas and approaches<\/span><\/li>\n
  • Testing, testing and more testing<\/span><\/li>\n<\/ul>\n
    \"\"
    MIT Sloan Management School illustrates the Design Thinking process this way<\/figcaption><\/figure>\n

    My first project as an intern was to further reimagine the redesigned V2 Beta docs. In this project, I was to:<\/span><\/p>\n

      \n
    1. Undertake a competitors\u2019 analysis between Razorpay and any select documentation sites of my choice.<\/span><\/li>\n
    2. Write down what they have that Razorpay doesn\u2019t, and rate those docs.<\/span><\/li>\n
    3. Present what ideas I had that would make Razorpay Docs better.<\/span><\/li>\n<\/ol>\n

      I was <\/span>thrilled<\/span><\/i>, not just because this was a project right up my alley but also because I had resolved to get to the bottom of the \u2018lack of functionality\u2019 part.<\/span><\/p>\n

      Learning Design Thinking<\/b><\/h1>\n

      You do not <\/span>learn<\/span><\/i> Design Thinking; you <\/span>observe<\/span><\/i> it. When a process involves watching and learning, you grasp the requirements and then take action to resolve those pain points.<\/span><\/p>\n

      As a part of my project, I researched, observed and created ideas for documentation that resolved my pain points. Some elements I idealised in Docs based on my personal usage were:<\/span><\/p>\n

        \n
      • Building a developer community for users, like many other documentation sites<\/span><\/li>\n
      • Having better aesthetics with corresponding accessibility<\/span><\/li>\n
      • Creating ingenious navigation and content-consumption mechanisms<\/span><\/li>\n
      • Having alt text, videos with closed captions, and the like<\/span><\/li>\n
      • Having tags for the individual pages to make navigation between pages more interactive and intuitive<\/span><\/li>\n<\/ul>\n

        When I presented my findings, they were well received and appreciated. In that process, I came across my first and significant learning:\u00a0<\/span><\/p>\n

        Docs are designed to communicate and satisfy a two-way requirement.<\/strong><\/em><\/p>\n

          \n
        • Every user that reaches the Docs has arrived with an intent: to find a resolution as quickly as possible.\u00a0<\/span><\/li>\n
        • Every Doc is created for one intent: Know what the user wants and fetch that information in record time.\u00a0<\/span><\/li>\n<\/ul>\n

          I resolved my pain points through this project while giving ideas based on my research. However, the work wasn\u2019t over; I still didn\u2019t see what the limitations of the functionality in the documentation were.\u00a0<\/span><\/p>\n

          And so unwittingly, unknowingly, I explored design thinking\u2026 via design thinking.<\/span><\/p>\n

          Implementing Design Thinking<\/b><\/h1>\n

          The concept note for the redesigned Docs detailed the need for better discoverability and improved user experience. The redesigned docs proposed two significant enhancements:<\/span><\/p>\n

            \n
          • Better discoverability: search experience and content navigation.<\/span><\/li>\n
          • Simplified, more accessible content: content structure and layout and interactivity.\u00a0<\/span><\/li>\n<\/ul>\n
            \"\"
            The redesigned Razorpay Docs site<\/figcaption><\/figure>\n

            Aftermath<\/b><\/p>\n

            The revamped documentation site, the one you see currently on Razorpay Docs, went live with these changes in June 2020. It was a sleek and energetic revamp. In the following months, our Docs Satisfaction measure (Docs CSAT, as we call it) soared.<\/span><\/p>\n

            But this was just the beginning. My own competition analysis detailed that a lot was yet to be done.<\/span><\/p>\n

            My second significant learning comes here:\u00a0<\/span><\/p>\n

            Design is a process, not a product. It is a continuous process.<\/strong><\/em><\/p>\n

            Conventionally, we say a product has a great design by its appearance. That\u2019s not wrong, but it is very generic. More often than not, it takes a while to recognise that in addition to its aesthetic value, we must look for its <\/span>functional<\/span><\/i> value too.<\/span><\/p>\n

            Razorpay Docs in the V2 Beta looked better than the old one. It had a better aesthetic design, signature colours, visual indicators, and more. The Docs catered to the user well because it was designed well. And vice versa. It checked off many boxes:<\/span><\/p>\n\n\n\n\n\n\n\n
            \u2714\ufe0f<\/span><\/td>\nFunctionality: can the Docs give users what they need for whatever reason they need it?<\/span><\/td>\n<\/tr>\n
            \u2714\ufe0f<\/span><\/td>\nAesthetics: how smartly does the appearance provide Razorpay\u2019s image and promise?<\/span><\/td>\n<\/tr>\n
            \u2714\ufe0f<\/span><\/td>\nDiscoverability: can the users find the items they are looking for?\u00a0<\/span><\/td>\n<\/tr>\n
            \u2714\ufe0f<\/span><\/td>\nNavigation: how well are users able to locate and contextualize the information?\u00a0\u00a0<\/span><\/td>\n<\/tr>\n
            \u2714\ufe0f<\/span><\/td>\nUser experience: how is the overall experience and satisfaction of the users?<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

             <\/p>\n

            The Docs Redesign in June 2022 was a one-time project, but we had to reach multiple other destinations. So we took measures to build upon that.<\/span><\/p>\n

            Design Thinking is a Continuous Process<\/b><\/h2>\n

            When design itself is a process, how could design thinking not be one too? Experts claim this openly: design thinking is <\/span>not<\/b> a linear, single-track process. It is messy and repetitive, and what worked at first might not make sense after a while.<\/span><\/p>\n

            No matter how high you soar, you still scratch surfaces again. You must.<\/i><\/strong><\/p>\n

            After the new designs went live, we worked on improving the documentation a whole lot more. What we have improved since then is for you to discover and tell us how you feel about it via the User Feedback module.\u00a0<\/span><\/p>\n

            As for what we continued to do, we did that by taking up projects to understand the user. These worked initially, but we soon reached a stagnation point. Then we changed our approach and will change it again when applicable. That\u2019s how it works.<\/span><\/p>\n

            In Hindsight<\/b><\/h2>\n

            It wouldn\u2019t make sense to talk so much about design thinking if I do not see how it applies to designing my write-ups. My writing and my understanding towards writing technical content have evolved in the process, and I am still imbibing my third learning:\u00a0<\/span><\/p>\n

            Write with solid intent after understanding the user persona.<\/i><\/strong><\/p>\n

            It reflects the most in my structuring and language, a stark but gradual shift from the write-ups I created as a Content Writer. What I wrote once was a glorifying advertising stunt, which has now become informative and immediately actionable.\u00a0<\/span><\/p>\n

            Intentional writing understands the users\u2019 needs and provides the necessary information. If not intentional, documentation will fail its core objectives.<\/span><\/p>\n

            To Conclude<\/b><\/h1>\n

            A massive chunk of Docs relies on the content, the raw material that must be written intentionally and is easy to consume. Talking to users and understanding where they are struggling with the content, design, structure, information, and experience is the key to creating incredible documentation.<\/span><\/p>\n

            Docs are an essential aid in helping users understand what the product offers. It is a great self-help tool that allows users to understand concepts, explain how-tos, help them integrate and troubleshoot. By using design thinking in the authoring, designing and delivery process, you always maintain sight of your users; the outcome is invaluable.<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

            Preamble My first acquaintance with Razorpay Docs began when I joined Razorpay as a Tech Writing Intern. Back then, the platform on razorpay.com\/docs was much different than what you currently see. I remember quite liking it!\u00a0 The docs then had a landing page with the products and subproducts lined up perfectly. The horizontal product line<\/p>\n","protected":false},"author":151156578,"featured_media":8000,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3370],"tags":[3651,3652],"class_list":{"0":"post-7997","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-resources","8":"tag-design","9":"tag-documentation"},"_links":{"self":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/7997","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=7997"}],"version-history":[{"count":3,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/7997\/revisions"}],"predecessor-version":[{"id":8025,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/7997\/revisions\/8025"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media\/8000"}],"wp:attachment":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media?parent=7997"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/categories?post=7997"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/tags?post=7997"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}