Requirements and plans

Business terms: your words, rules and constraints

Download the template, describe your business once for the organisation or per project, or start from an industry pack.

Business terms tell Yavaren how your business talks and works, the way you would brief a new analyst on your team. They are used in every step of a requirement: the brief, the features, the stories and the build. Yavaren cites them by id (for example BR-3) and asks you when a document contradicts them.

The template

Open Requirements → Business terms and download the template as Markdown, CSV or Excel. A filled-in example for a fictional company shows what good entries look like. The template has ten sections, each with guidance:

• Glossary: your words and what they mean.
• Actors and roles: who uses or is affected by the system.
• Business rules: rules that must always hold, with their exceptions.
• Entities and lifecycle: the records you keep and the states they move through.
• KPIs: what you measure and the target.
• Regulatory and compliance: laws, standards and policies that apply.
• Non-functional requirements: speed, availability, security, accessibility, where data is kept.
• Integrations: other systems and what is exchanged.
• Out of scope: what this must not do.
• Open questions: what you have not decided yet.

Upload

Admins upload the organisation's terms, used for every project. Members can add terms for one project; where both define the same thing, the project's terms win and Yavaren asks you about the difference. Yavaren checks the file before it is stored and lists every problem with its row, so you can correct it. Each upload is a new version, and earlier versions stay available to download.

Files are read by their content, never run, and kept with your organisation's other documents.

Industry packs

Start from a pack for your industry: financial services, healthcare, retail and e-commerce, public sector, manufacturing and logistics, education, or a general one. A pack includes a compliance checklist and, for some industries, a reference architecture. Download it to adapt it, or use it directly for the organisation or a project. Some packs are part of a paid package.