Search 1.9 billion lines of Odoo code on GitHub
business_requirement
<a class="reference external image-reference" href="https://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="business-requirement"></a>
<h2>Business Requirement</h2>
<a name="introduction"></a>
<h3>Introduction</h3>
<a name="what-is-a-business-requirement"></a>
<h4>What is a Business Requirement?</h4>
<p>A <strong>Business requirement</strong> (BR) is the expression of a business need by a customer
or internal project user.</p>
<p>A BR contains multiple different parts to explain the stakeholder need and how to
meet his/her requirements:</p>
<ul class="simple">
<li><strong>Customer Story</strong>: this is the requirement as expressed by the customer</li>
<li><strong>Scenario</strong>: How/where the current solution can provide a suitable scenario to
answer the customer story</li>
<li><strong>Gap</strong>: For the uncovered part of the scenario, elaborate the gap/need for specific
developments/setup</li>
<li><strong>Test case</strong>: A set of conditions under which a tester will determine whether the application, software system or
one of its features is working as it was originally established for it to do.</li>
<li><strong>Deliverables</strong> to be provided to the customer/user</li>
<li><strong>Resources</strong> necessary to achieve the deliverables</li>
<li><strong>Additional</strong> information (approval, cost control etc.)</li>
</ul>
<p>This set of modules was originally designed for the service/IT industry but the
requirement management design has been kept as generic as possible so that it can
apply to many other cases/industries (customer or internal projects):</p>
<ul class="simple">
<li>Construction</li>
<li>Trading (New product development)</li>
<li>Business Consultancy</li>
<li>Web or IT development</li>
<li>R&D projects</li>
<li>etc.</li>
</ul>
<p>More information about business requirements management:</p>
<ul class="simple">
<li><a class="reference external" href="https://en.wikipedia.org/wiki/Business_requirements">Wikipedia</a></li>
<li><a class="reference external" href="https://www.isixsigma.com/implementation/project-selection-tracking/business-requirements-document-high-level-review/">Six Sigma</a></li>
</ul>
<a name="business-requirement-set-of-modules"></a>
<h4>Business Requirement set of modules</h4>
<p>This module is part of a set (<a class="reference external" href="https://github.com/OCA/business-requirement/tree/10.0">Business Requirements repo</a>).</p>
<p>The base Business Requirements module creates the basic objects and
can be used as a standalone module.</p>
<div class="figure">
<img alt="Business Requirement List view" src="../business_requirement/static/img/bus_req_tree.png" style="width: 600px;" />
</div>
<p>Multiple modules integrate the BR with other business areas, such as Sales,
Procurement, Project or Analytic Accounting. For example:</p>
<ul class="simple">
<li>Sales Quotation can have an estimation supported by a BR analysis</li>
<li>Project Tasks can be related to the BRs they implement or support</li>
<li>Procurement and purchase can be generated out of the BR</li>
</ul>
<div class="figure">
<img alt="Business Requirement modules diagram" src="../business_requirement/static/img/bus_req_module_diag.png" style="width: 600px;" />
</div>
<p>The following workflow explains the business workflow between the BR modules and other applications in Odoo:</p>
<div class="figure">
<img alt="Business Requirement integration in Odoo" src="../business_requirement/static/img/bus_req_workflow.png" style="width: 600px;" />
</div>
<a name="how-to-use-this-module"></a>
<h4>How to use this module?</h4>
<p>This module only contains the standard base models for business requirement:</p>
<ul class="simple">
<li>BR model definition</li>
<li>Standard setup and views</li>
<li>Standard Workflow</li>
</ul>
<div class="figure">
<img alt="Business Requirement Form" src="../business_requirement/static/img/bus_req.png" style="width: 600px;" />
</div>
<a name="configuration"></a>
<h3>Configuration</h3>
<a name="users"></a>
<h4>Users</h4>
<ul class="simple">
<li><strong>Business Requirement User</strong>: can create and confirm a BR</li>
<li><strong>Business Requirement Manager</strong>: can create, confirm and approve a BR</li>
</ul>
<a name="alias-and-emails"></a>
<h4>Alias and emails</h4>
<p>You can setup an alias in Settings/Technical/Email/Alias in order to create
business requirements directly from email received at a specific address.</p>
<div class="figure">
<img alt="Email Alias setup" src="../business_requirement/static/img/bus_req_alias.png" style="width: 600px;" />
</div>
<p>You can start conversation with the followers in the chatter area of the
BR like in tasks, issue or CRM leads.</p>
<a name="sequences"></a>
<h4>Sequences</h4>
<p>Default numbering format: BR123456.</p>
<p>You can modify the default numbering sequence in Settings/Technical/Sequences&Identifier/Sequences.</p>
<p>Search for Business Requirement sequence and alter it if necessary.</p>
<a name="tags"></a>
<h4>Tags</h4>
<p>You can create and assign tags for your business requirements in Business Requirements/Configuration/Bus. Req. Category</p>
<div class="figure">
<img alt="Define Tags" src="../business_requirement/static/img/bus_req_tags.png" style="width: 600px;" />
</div>
<a name="master-project"></a>
<h4>Master project</h4>
<p>You can define a master project linked to the business requirement.</p>
<p>Followers from the project will automatically be added to the business requirements.</p>
<a name="usage"></a>
<h3>Usage</h3>
<a name="simple-br"></a>
<h4>Simple BR</h4>
<ol class="arabic">
<li><p class="first">Define the header information</p>
<ul class="simple">
<li>Master Project (Partner is the one related to the master project)</li>
<li>Priority (low, Medium, High)</li>
<li>Change request: Is it a change request? (currently only informational with n model or action)</li>
<li>Tags: any relevant tag for the business.</li>
<li>Owner and approver by default</li>
</ul>
<div class="figure">
<img alt="Input header information" src="../business_requirement/static/img/bus_req_tags2.png" style="width: 600px;" />
</div>
</li>
<li><p class="first">Input the customer story, scenario gap and test case(simple html editor with image and text)</p>
<div class="figure">
<img alt="Input customer story, scenario, gap and test case" src="../business_requirement/static/img/bus_req_cust_story.png" style="width: 600px;" />
</div>
</li>
<li><p class="first">Confirm the Business requirement (for BR User and Manager)
At that stage the Customer story/Scenario/Gap/Test case is not modifiable anymore</p>
<div class="figure">
<img alt="Confirm your business requirement" src="../business_requirement/static/img/bus_req_confirmed.png" style="width: 600px;" />
</div>
</li>
<li><p class="first">Approve the Business requirement (for BR Manager)</p>
<div class="figure">
<img alt="Confirm your business requirement" src="../business_requirement/static/img/bus_req_approved.png" style="width: 600px;" />
</div>
</li>
<li><p class="first">Once your requirement is finished and delivered you can set it as Done</p>
<div class="figure">
<img alt="Confirm your business requirement" src="../business_requirement/static/img/bus_req_done.png" style="width: 600px;" />
</div>
</li>
<li><p class="first">Alternatively, you can cancel the BR (in case it is not relevant or mistake) or drop it (when customer makes the decision to discontinue it)</p>
<div class="figure">
<img alt="Cancel your business requirement" src="../business_requirement/static/img/bus_req_cancel.png" style="width: 600px;" />
</div>
<div class="figure">
<img alt="Drop your business requirement" src="../business_requirement/static/img/bus_req_drop.png" style="width: 600px;" />
</div>
</li>
</ol>
<a name="sub-business-requirements"></a>
<h4>Sub-business requirements</h4>
<p>User can create sub business requirements for a given BR for complex cases.</p>
<p>This is a simple parent/child relation (see roadmap).</p>
<div class="figure">
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/222/10.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
</div>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>Multi-company management</li>
<li>Full change request management</li>
<li>Analytic account management</li>
<li>Complex relationship management</li>
<li>Integration with earned-value module.</li>
<li>Improve the followers details (eg: depending on the stages)</li>
<li>Focus should be on description field (When BR form open it direct focus on</li>
</ul>
<p>use-case field).</p>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/business-requirement/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Eric Caudal <<a class="reference external" href="mailto:eric.caudal@elico-corp.com">eric.caudal@elico-corp.com</a>></li>
<li>Alex Duan <<a class="reference external" href="mailto:alex.duan@elico-corp.com">alex.duan@elico-corp.com</a>></li>
<li>Xie XiaoPeng <<a class="reference external" href="mailto:xie.xiaopeng@elico-corp.com">xie.xiaopeng@elico-corp.com</a>></li>
<li>Victor M. Martin <<a class="reference external" href="mailto:victor.martin@elico-corp.com">victor.martin@elico-corp.com</a>></li>
<li>Evan Li <<a class="reference external" href="mailto:li.aiwen@elico-corp.com">li.aiwen@elico-corp.com</a>></li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>