How to Create a Mobile Application Requirement Document

如何创建移动应用程序需求文档

2022-09-07 21:00 clickhelp

本文共1499个字,阅读需15分钟

阅读模式 切换至中文

In today's market, you will hardly get your business idea to work and bring profit if you don’t have a mobile application. People have already gotten used to doing business online and cannot imagine any other way of transacting. A mobile app can attract new buyers, make your company grow, and ‘speak the same language’ with the customers. However, an app can become a disappointment both for you and the users if it doesn’t reflect your idea clearly. For example, you want to create an art auction platform where people can bid for the artwork on sale plus get it framed and delivered to any part of the world. The idea is simple, but when the users open the app, they don’t understand the bidding policy, the payment procedure, etc. These pain points will make them delete the app and look for another one where things can be grasped intuitively. To avoid these problems, before ordering the app from the contractor, you need to create a mobile application requirement document explaining your vision and requirements for the future product. What Is a Mobile Application Requirement Document? A requirement document contains your assumptions about how the app should work and what it should look like: it describes the general idea gives an outline of functions compares your app with the existing ones enumerates technical details. All these elements are essential for developers. They will help them understand what makes your product stand out among others. Let’s proceed with the example of the art auction app. You order it from a software development company, and when you finally get the product, you realize it does not meet your company’s needs. This has probably happened because you haven’t explained to your contractors the most outstanding feature of the app – that it is an auction platform. As a result, you got just an online market app where people can buy and sell artwork without bidding. A mobile application requirement document or a product requirement doc (PRD) is to give the app development contractor an overview of a future mobile app. This document is the cornerstone of your success, as it shows the logic of the product, lists its technical features, and finally helps the developers to create a fully functional app. Putting it differently, a PRD tells software developers what to do, what the target market is, and how the product will be helpful for the users. If you take an analogy with engineering and design, a PRD is like a pre-FEED document used at the pre-design stage before the design and construction begins. A mobile app requirement doc cannot be regarded as a technical assignment or terms of reference, as it does not contain the exact details. This is because, quite often, the customer (the one who wants to create an art auction platform, for example) does not understand the technical side of the development process. The technical details are usually left to the developers. Why Is It Vital to Write Requirement Documents? Requirement documents are written to avoid discrepancies between the customer’s vision of the future product and the way the contractors fulfill the task. A PRD is a statement of your vision of the product, the way you want it to look and function. A mobile app requirement doc is usually aimed at: Giving the developer a general understanding of the business. The way things work in this or that field may be unclear for the contractor; in the example above with the art auction app, you will have to explain that an art market is a particular type of market where the main problem is to establish the price of the product (artwork), and an auction is the best way to solve this problem; besides, an auction can ensure better conditions and more freedom for both artists and buyers. Giving the developer a general understanding of the application design. Explaining what you want the app to look like in the long run – shall it include a personal account for each artwork buyer and seller, will there be separate catalogs like at Christie’s or Sotheby’s or just a common platform for all works categorized by genre or group, or date? Saving time and effort for both the customer and the developer. These vital resources are often wasted when the customer has to explain over and over again what is required and the contractor to adjust and re-adjust the project. Assessing the time and cost of software development. Based on the PRD, the contractor will be able to estimate all the costs related to the development of the app. Steps to Write a Mobile Application Requirement Document To create an effective mobile application requirement doc, it is important to follow the steps listed below. Product Vision Statement It is good when the idea of the product is defined in one sentence. This makes it not only understandable but ‘catchy’ like a slogan. In this case, it can be easily memorized and referred to when necessary in the process of work. A vision statement is a formula for the ultimate goal of the app. At the same time, it should contain a solution to the problem you suppose the users are facing. The formula of a vision statement (2Ws + 2Hs) includes the answers to the following questions: Who is the product intended for (in the example with the artwork auction app, the target market is represented by buyers and sellers of art)? What is the goal of the user (buy or sell artwork)? How will the product help the user (help to sell/buy a product not at a fixed price but auction terms)? How is the product different from similar products (an auction helps to establish a fair market price of the product, as compared with simple marketplaces where the price is fixed and depends on the policy of the marketplace rather than on the real market conditions)? Sequence of Actions This step implies the description of the way the user navigates the app. Start describing the onboarding screen and pass it over to the registration form, home tab, etc. Depending on the PRD format, the document can include screenshots of similar apps or sketches of what the pages should look like in your view (wireframes). Priority Features To get a clearer picture of what your future app should be, it is reasonable to explore the existing apps on the market and decide, based on the comparison, which features will be best for you. You should also highlight the features that developers should avoid. Priority features usually include sign-up and login, image galleries, social media integration, shopping carts, payments, calendar integrations, push notifications, etc. Wireframes Wireframes are a means of visualization. They help to illustrate the text and explain all the constraints and dependencies of the mobile application. If there are four or more wireframe screens, you can create the screen map. Screen maps complement the text in the requirements document even further. They help give a visual representation and help the developers understand the description more precisely. Choosing a Tool The final step is to choose a tool to help implement the idea. ClickHelp is an online technical documents management platform that allows users to create, edit, publish, share, and translate documents. The main principles of work are content reuse, single sourcing, co-authoring, and distribution of user roles. With content reuse you will be able to reuse fragments of text without having to rewrite from scratch every time you have to deal with similar information. Single sourcing allows you to make your documentation uniform, as texts will refer to one or several source documents. Co-authoring means collaboration between authors, reviewers, and translators. Your workflow will become more efficient as you distribute work between different assignees. A team (not just one employee) can work on the same doc at a time. All stakeholders will be able to exchange comments right on the ClickHelp platform. This is much faster and more efficient than exchanging e-mails. The system allows the efficient structure of documents by configuring the TOC (Table of Contents) shown on a separate panel. You can insert links to any materials you need and do it easily. Just highlight the necessary word, phrase, or passage. Then choose the Insert tab on the ribbon and click on the link icon. The same applies to downdrops and commenting. Just highlight the necessary fragment and insert a downdrop or a comment. Conclusion If you want your future app to function properly, reflect your business idea and, more importantly, get this idea across to the target audience, you can hardly do without a mobile application requirement document. It has become essential to cooperation between the customer and software developers. It will help you clarify your product vision to the developer team. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
在今天的市场上,如果你没有一个移动应用程序,你很难让你的商业想法发挥作用并带来利润。人们已经习惯了在网上做生意,无法想象任何其他的交易方式。一个移动应用程序可以吸引新的买家,让你的公司发展壮大,并与客户“说同一种语言”。 然而,如果一个应用程序不能清楚地反映你的想法,它可能会让你和用户都失望。例如,您想要创建一个艺术品拍卖平台,在这里人们可以竞拍出售的艺术品,并将其装裱并交付给世界任何地方。想法简单,但当用户打开app时,并不了解竞价政策、缴费程序等,这些痛点会让他们删除app,另找一个能直观掌握事情的地方。 为了避免这些问题,在向承包商订购应用程序之前,您需要创建一个移动应用程序需求文档,解释您对未来产品的愿景和需求。 什么是移动应用需求文档? 需求文档包含您对应用程序应该如何工作以及应该是什么样子的假设: 它描述了大意 给出函数的大纲 将您的应用程序与现有的应用程序进行比较 枚举技术细节。 所有这些元素对于开发人员来说都是必不可少的。他们将帮助他们了解是什么使你的产品脱颖而出。 让我们继续艺术拍卖应用程序的例子。你从软件开发公司订购,当你最终得到产品时,你意识到它不符合你公司的需求。发生这种情况可能是因为你没有向你的承包商解释该应用程序最突出的功能--它是一个拍卖平台。因此,你得到了一个在线市场应用程序,人们可以在那里买卖艺术品,而无需出价。 移动应用程序需求文档或产品需求文档(PRD)是向应用程序开发承包商提供未来移动应用程序的概述。 这篇文档是您成功的基石,因为它展示了产品的逻辑,列出了它的技术特性,并最终帮助开发人员创建一个功能齐全的应用程序。 换句话说,PRD告诉软件开发人员该做什么,目标市场是什么,以及产品将如何帮助用户。如果你拿工程和设计作类比的话,PRD就像是在设计和施工开始前的预先设计阶段使用的预馈文件。 移动应用程序需求文档不能被视为技术任务或职权范围,因为它没有包含确切的细节。这是因为,客户(例如,希望创建艺术品拍卖平台的客户)通常不了解开发过程的技术方面。技术细节通常留给开发人员。 为什么编写需求文档是至关重要的? 需求文档的编写是为了避免客户对未来产品的愿景与承包商完成任务的方式之间的差异。PRD是你对产品的愿景的陈述,是你希望它看起来和功能的方式。 一个移动应用需求文档通常针对: 使开发人员对业务有一个大致的了解。承包商可能不清楚这一领域或那一领域的工作方式;在上面的艺术品拍卖应用程序的示例中,您必须解释艺术品市场是一种特殊类型的市场,其主要问题是确定产品(艺术品)的价格,而拍卖是解决这个问题的最佳方式;此外,拍卖可以确保艺术家和买家都有更好的条件和更多的自由。 使开发人员对应用程序设计有一个大致的了解。解释你希望该应用程序的长期外观--它是否包括每个艺术品买家和卖家的个人账户,是否会有像佳士得或苏富比那样的单独目录,或者只是一个公共平台,为所有按流派或群体或日期分类的作品分类? 为客户和开发人员节省时间和精力。当客户不得不一遍又一遍地解释需要什么,承包商不得不调整和再调整项目时,这些重要的资源往往被浪费了。 评估软件开发的时间和成本。根据PRD,承包商将能够估计与开发应用程序有关的所有成本。 编写移动应用程序需求文档的步骤 要创建一个有效的移动应用程序需求文档,遵循下面列出的步骤是很重要的。 产品愿景声明 当产品的想法用一句话来定义时,这是好的。这使得它不仅可以理解,而且像口号一样‘朗朗上口’。在这种情况下,可以很容易地记忆,并在工作过程中必要时参考。 愿景声明是应用程序最终目标的公式。同时,它应该包含您认为用户面临的问题的解决方案。愿景陈述(2WS+2HS)的公式包括对以下问题的回答: 产品是面向谁的(在艺术品拍卖应用程序的示例中,目标市场由艺术品的买家和卖家代表)? 用户的目标是什么(购买或出售艺术品)? 产品将如何帮助用户(帮助销售/购买产品,而不是以固定的价格,而是拍卖条款)? 产品与类似产品有何不同(与价格固定并取决于市场政策而不是实际市场条件的简单市场相比,拍卖有助于确定产品的公平市场价格)? 动作顺序 这一步意味着对用户导航应用程序的方式的描述。开始描述登录屏幕,并将其传递到注册表单、主页标签等。根据PRD格式,文档可以包括类似应用程序的截图或页面在您视图中应该是什么样子的草图(线框)。 优先特征 为了更清楚地了解你未来的应用程序应该是什么,合理的做法是探索市场上现有的应用程序,并根据比较决定哪些功能最适合你。您还应该突出显示开发人员应该避免的特性。 优先功能通常包括注册和登录、图像库、社交媒体集成、购物车、支付、日历集成、推送通知等。 线框 线框是一种可视化的手段。它们有助于说明文本并解释移动应用程序的所有约束和依赖关系。如果有四个或更多的线框屏幕,则可以创建屏幕映射。屏幕地图进一步补充了需求文档中的文本。它们有助于提供可视化表示,并帮助开发人员更准确地理解描述。 选择工具 最后一步是选择一个工具来帮助实现这个想法。ClickHelp是一个在线技术文档管理平台,允许用户创建、编辑、发布、共享和翻译文档。工作的主要原则是内容重用、单一来源、共同创作和用户角色的分配。 使用内容重用,您将能够重用文本片段,而不必在每次处理类似信息时从头重写。单一来源允许您使文档统一,因为文本将引用一个或多个源文档。 合著是指作者、审稿人和译者之间的合作。在不同的受理人之间分配工作时,工作流将变得更加高效。一个团队(不仅仅是一个员工)可以同时处理同一个文档。所有涉众将能够在ClickHelp平台上交换评论。这比交换电子邮件要快得多,效率也高得多。 该系统通过配置显示在单独面板上的TOC(目录)来实现文档的高效结构。您可以插入链接到您需要的任何材料,并很容易做到这一点。只需突出所需的单词、短语或段落。然后选择功能区上的插入选项卡并单击链接图标。这同样适用于下拉和评论。只需突出显示必要的片段,并插入一个下拉或注释。 结论 如果你想让你未来的应用程序正常运行,反映你的商业想法,更重要的是,让这个想法传达给目标受众,你几乎离不开一个移动应用程序需求文档。客户和软件开发人员之间的合作已经成为必不可少的。它将帮助您向开发团队阐明您的产品愿景。 祝你的技术写作好运! ClickHelp团队 跨平台和设备编写、托管和交付文档

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文