{"id":10681,"date":"2024-04-23T16:46:39","date_gmt":"2024-04-23T11:16:39","guid":{"rendered":"https:\/\/razorpay.com\/learn\/?p=10681"},"modified":"2024-04-25T14:58:30","modified_gmt":"2024-04-25T09:28:30","slug":"writing-help-docs-for-mobile-devices-and-apps","status":"publish","type":"post","link":"https:\/\/razorpay.com\/learn\/writing-help-docs-for-mobile-devices-and-apps\/","title":{"rendered":"Writing Help Docs for Mobile Devices and Apps"},"content":{"rendered":"

Would you believe me if I said that the first handheld mobile phone call was made 50 years ago? Yes, it is true. And there is a petty story behind this call. Half a century ago, Motorola and Bell Labs were racing to develop the world\u2019s first cell phone. On 3 April 1973, a Motorola employee, Martin Cooper, made the first mobile call to his rival, Dr. Joel S. Engel of Bell Labs.<\/span><\/p>\n

\"\"
Martin Cooper, Image Source: https:\/\/upload.wikimedia.org\/wikipedia\/commons\/<\/figcaption><\/figure>\n

We have come a long way since then. We have seen the Apple vs. Samsung wars and the Android vs. Symbian wars. Today, none of us can imagine a life without cell phones. When we buy a new cell phone (fresh off Flipkart, Amazon, or your favourite retailer), we savour the feel of the pristine device and express delight over its design. However, the neat little manual that arrives with the device remains untouched and unread.\u00a0<\/span><\/p>\n

Like any other device, mobile phones need an instruction manual for users to discover and use features as expected. There is a hardware manual and a software manual (which resides within the device).<\/span><\/p>\n

The hardware manual outlines the physical components and specifications of the mobile device. It includes details about the SIM card slots, memory, battery, storage, display, camera, ports, buttons, and dimensions.<\/span><\/p>\n

\"\"
Source: https:\/\/data2.manualslib.com\/<\/figcaption><\/figure>\n

On the other hand, the software manual guides users on interacting with the software, customising settings, installing and using apps, and troubleshooting software issues.<\/span><\/p>\n

\"\"
A software manual written for mobile<\/figcaption><\/figure>\n

And, of course, there are millions of apps out there that we can install and use – some come with manuals, some don\u2019t.<\/span><\/p>\n

Factors to Consider When Writing Mobile-Based Help Docs<\/span><\/h2>\n

As mentioned earlier, documentation for mobile devices and apps could be paper-based and online. And both come with their own set of constraints, as discussed in the blog on <\/span>documenting for different media<\/span><\/a>.<\/span><\/p>\n

In this blog, we will explore the elements to consider when creating mobile-based documentation. The help files could be embedded within the app, or the user could be redirected to another external site. In either case, the user is still on a mobile device, and hence we need to take into account the following:<\/p>\n

Content Organisation<\/span><\/h3>\n

Due to the limited real estate, writers have to be really careful about how they want to organise and present the information. Mobile users come to help sections when stuck with a particular action. Hence, most apps\u2019 help section consists of a list of help topics, tapping on which takes the user to a list of FAQs.<\/span><\/p>\n

By organising the information in a task-oriented manner, writers can make it easier for users to solve their pressing concerns. Let us assume you are tired of the WhatsApp forwards on a group (maybe the good morning messages?) and want to mute notifications. You tried to figure it out yourselves but weren\u2019t successful. Then you came to the help section, and voila, you did it! Here is how WhatsApp\u2019s help guide looks:<\/span><\/p>\n

\"\"
WhatsApp Help Files<\/figcaption><\/figure>\n

Content Structure<\/span><\/h3>\n

Brevity is key while writing content for mobile help. Writers should draft concise, to-the-point content so that the user can quickly scan and find information. It may not be easy, but it is necessary!<\/span><\/p>\n

Perhaps writers can empathise with Mark Twain. He once said, \u201cI didn’t have time to write a short letter, so I wrote a long one instead.\u201d<\/span><\/p><\/blockquote>\n

Writers must keep the following in mind when structuring the content:<\/span><\/p>\n

    \n
  • As is true with creating any kind of technical documentation, writers must break the content into short, logical sections.<\/span><\/li>\n
  • Add section headings that grab user attention. In the WhatsApp help section, users scan the section headings to find the steps to share status updates to Facebook vs. other apps.<\/span>\n

    \"\"
    Creating Sections: An effective way of organising content.<\/figcaption><\/figure><\/li>\n<\/ul>\n
      \n
    • Add numbered steps so users can quickly understand the sequence of actions and resolve their issues.\u00a0<\/span><\/li>\n
    • Use visual elements such as the UI icons so users can relate to the steps. Add screenshots and videos. However, remember not to add large, heavy images as these could increase screen load time. Observe how Amazon has smartly used graphics to explain how to change language preferences:
      \n<\/span><\/span><\/p>\n

      \"\"
      Using Media in Mobile Help Files<\/figcaption><\/figure><\/li>\n<\/ul>\n

      Interaction Descriptions<\/span><\/h3>\n

      One of the biggest differences in documenting web and mobile interfaces is how interactions are described.\u00a0<\/span><\/p>\n

        \n
      • On the web, we click and scroll (unless you have touch-screen laptops\/desktops).<\/span><\/li>\n
      • On mobile, we tap, swipe, pinch, long-press, scan and so on. Add to it voice-based commands and gestures and usage of stylus\/pen. Now, add the difference between Android and iPhone UI.<\/span><\/li>\n<\/ul>\n

        Writers need to be mindful of these different interactions and document them accordingly. Here\u2019s an example of how Samsung has documented its circle-to-search gesture.<\/span><\/p>\n

        \"\"
        Samsung’s Cirlce-to-Search Feature<\/figcaption><\/figure>\n

        Video Content Strategy<\/span><\/h3>\n

        Video is now one of the most preferred mediums for consuming content on mobile – the popularity of Instagram reels and YouTube shorts attest to that. By adding an exclusive set of video guides, writers can help users grasp instructions quickly and in a medium they are used to. After all, not everybody likes to read.<\/span><\/p>\n

        Amazon has created short videos that users can refer to for simple, everyday actions, such as checking package delivery dates, tracking pages, and so on.\u00a0<\/span><\/p>\n

        \"\"
        Using Videos as an illustration tool in Help Files<\/figcaption><\/figure>\n

        Conclusion<\/span><\/h2>\n

        With the rising number of mobile users, creating mobile-based help documentation is absolutely necessary. It aids users in their journey, helping them achieve their goals\u2014as simple as returning a package or as complex as managing their finances or learning a new language.<\/span><\/p>\n

        Humans take to technology like ducks take to water, but sometimes, even ducks need a gentle nudge in the right direction. That\u2019s where clear and helpful documentation comes in\u2014helping users find their way around, solve problems, and get the most out of their digital experiences.\u00a0<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

        Would you believe me if I said that the first handheld mobile phone call was made 50 years ago? Yes, it is true. And there is a petty story behind this call. Half a century ago, Motorola and Bell Labs were racing to develop the world\u2019s first cell phone. On 3 April 1973, a Motorola<\/p>\n","protected":false},"author":151156543,"featured_media":10683,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3606],"tags":[],"class_list":{"0":"post-10681","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\/10681","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=10681"}],"version-history":[{"count":5,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/10681\/revisions"}],"predecessor-version":[{"id":10709,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/posts\/10681\/revisions\/10709"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media\/10683"}],"wp:attachment":[{"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/media?parent=10681"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/categories?post=10681"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/learn.razorpay.in\/learn\/wp-json\/wp\/v2\/tags?post=10681"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}