App requirements document: what an app spec is and why you approve it

What a one-page app spec contains, how to read and question one before anything is built, the gaps to look for, and how changes are planned too.

The Deployflix team

·

The one-page spec you approve first: cover of the Deployflix blog post

An app requirements document, or app spec, is a short written plan of an app before anyone builds it: who will use it, the screens each of them sees, the information it keeps, the services it connects to, what is left out for now and what the build can cost at most. You read it, question it and change it, and only when it describes the app you actually want do you approve it.

You approve it first because a spec is the cheapest place to find a mistake. Moving a line on a page costs nothing. Finding out after the build that tutors can see every parent’s phone number, or that fees cannot be paid in instalments, means rebuilding.

What is a software specification, in plain words?

In software, a specification (in larger projects often called a requirements document, or SRS, for software requirements specification) is the agreement between the person who needs the app and whoever builds it. It says what the app must do, not how the code does it. For a shop, a club or a school, one page is usually enough, as long as it is specific and in plain words.

The test of a spec is simple: could two different builders read it and make roughly the same app? If the page says students can see their results, that is a wish. If it says a student signs in with a phone number and sees the marks of their own tests, by subject, next to the batch average, that is a requirement someone can build and you can check.

What goes into a one-page app requirements document?

Take a tutoring centre that wants an app for classes, attendance and fees. A useful one-page spec for it has these parts:

Part of the specWhat it saysExample for a tutoring centre
Who uses itEach kind of person who signs in, and what they may doOwner, tutors, students and parents; only the owner sees fee totals
Screens by roleThe pages each role sees and what they do thereTutor: today’s classes, mark attendance, enter test marks. Parent: attendance, marks, fees due
Data keptThe records the app stores and what each one holdsStudents, classes, attendance per session, tests and marks, fee instalments and receipts
IntegrationsOutside services it connects to, and howFee payments online through a payment gateway, with a receipt for each instalment
Left out for nowWhat this version will not doNo timetable clash checking; no import of last year’s records
Cost ceilingThe most the build can costA maximum shown before approval, not an estimate after the work

Screens by role is the part people skim, and it matters most. An app is really several apps sharing one set of data: the owner’s view, the tutor’s view and the parent’s view. Reading the screens role by role is how you notice that a tutor can mark attendance but nobody can correct a mistake in it.

The left out for now line is just as important. It tells you what you are not getting, which is the usual source of disappointment after a build. A short, honest list of exclusions is a sign of a good spec, not a weak one.

When you describe an app to Deployflix, the spec it writes follows this shape: who uses the app, its screens, the data it keeps, what is left out for now and what the build can cost at most, in the language you wrote in. If something in your description is unclear, it asks before it plans. How it works shows where the spec sits among the steps.

How do you read an app spec and question it?

Don’t read a spec like a contract, top to bottom. Read it like a day in your business.

  1. Walk through a real day as each role. What do they tap, what do they see, what do they enter? Then do the same for every other role.
  2. Follow one record from start to end. Pick a single student, order or booking. Who creates it, who changes it, who can delete it, and where does it end up?
  3. Look for the unhappy paths. A cancelled booking, a refund, a wrong entry, a payment that fails, a member who leaves. If the spec only describes things going right, ask what happens when they don’t.
  4. Check every number and word you would print. Invoice formats, fee instalments, tax lines and receipt numbers should match how you work today. If your invoices must show a tax such as GST, VAT or sales tax, check the details with your accountant.
  5. Ask about anything vague. Words like manage, track, easy and reports hide decisions. Ask: which report, showing what, for whom?

Which gaps should you look for before approving?

Most specs that go wrong are not wrong; they are incomplete. These are the gaps that come up most often.

Who can see what

Roles are easy to name and easy to leave vague. Check what each role can see, not just what it can do. Can a tutor see fees? Can one parent see another child’s marks? Can a staff member download the customer list? If the app keeps personal information, decide now who can see it.

Editing, cancelling and undoing

Every record will one day need correcting. Check that the spec says who can edit or cancel an entry, and whether the old value is kept.

Money

If the app takes payments, the spec should show the payment steps: which ways customers can pay (cards and local payment methods), what is being paid for, whether part payment is allowed, what the customer receives afterwards, and what happens to an unpaid or failed payment. Refund rules are a business decision, so write yours down. Gateways usually charge a percentage per transaction, plus a fixed fee in many countries, so check your gateway’s pricing page. Deployflix apps take payments through a payment gateway such as Razorpay or Cashfree; international gateways are coming soon. Our integrations page shows what connects today.

Messages and reminders

If you expect reminders, say how they should reach people: by email, inside the app, or another way. If the spec does not mention a channel, assume it isn’t there.

Your existing data

Spreadsheets and old registers often need to move into the new app. Ask whether bringing them in is part of the spec or sits in the left out list.

Devices and languages

Will people use it on a phone, a shop-counter computer or both? Does it need to be in Spanish, Arabic, French or another language as well as English? These shape the screens, so settle them before the build. Deployflix writes your app’s words in the language you ask for, and works itself in 41 languages.

Why approve the spec before anything is built?

Because changing a sentence is cheaper than changing an app. Before the build, adding a parent role or a fee instalment is an edit to a page. After the build, the same change can touch screens, data and permissions that were already finished.

Approving also gives you something to check the finished app against. When the build is done, open the spec and tick through it: each role, each screen, each piece of data. Anything missing is a fair point to raise.

The spec also settles cost before you commit. When the most a build can cost is written on the spec, you decide with the number in front of you. On Deployflix that ceiling is shown before you approve, and you pay only for what the build really used, as the pricing page explains.

How are changes planned after the app is built?

An app is rarely finished. A new course, a second location, a new way of collecting fees: each deserves the same care as the first build.

Plan a change as a small spec of its own: what changes, which roles and screens it touches, what data is added or altered, what stays the same, and what it can cost. Read it with the same questions and approve it before work starts. Keep the earlier version, so that if the change goes wrong you can go back to one that worked.

This is how Deployflix handles changes: you say what to change, it plans the change as the next version, and nothing is built until it is approved. Every earlier version is kept. In an organisation, only people whose role allows it can approve, as the security page describes.

An app spec template you can use

If you are writing your own spec, copy these headings and fill each with plain sentences:

  • The app in one sentence: who it is for and the job it does.
  • Roles: each kind of user and what they may see and do.
  • Screens by role: for each role, the screens and what happens on each.
  • Data kept: each kind of record and the details it holds.
  • Integrations: payments, your domain, app stores, where the code is kept, and anything else it connects to.
  • Rules: fees, limits, deadlines, cancellations and refunds.
  • Left out for now: what this version will not do.
  • Cost ceiling and approval: the most it can cost, and who signs off.

For worked examples of roles, screens and data, look at a coaching batch management system or a clinic appointment booking app. A founder testing an idea can keep the spec even shorter, with one role, a few screens and a firm list of what is left out, as for a startup MVP web app.

Questions

What is the difference between an app spec and a requirements document?

Mostly length and formality. A requirements document for a large project can run to many pages of numbered requirements. An app spec for a small business covers the same ground (who uses it, what it does, what it keeps) on one page, in plain words.

Who should write the app spec?

The person who knows the business supplies the content: the roles, the daily work and the rules. A builder can turn that into a structured spec, but only you can tell whether it is right.

Can I change the spec after I approve it?

Yes. Treat it as a change: describe what is different, read the updated plan and approve it again. Keep the earlier version so you can compare or go back.

How long should an app spec be?

Long enough that nothing important is left to guesswork, short enough that you will read all of it. For most small-business apps one page is right; if it runs much longer, consider building in stages.

Describe your app

Write what you need in your own words. Deployflix writes a one-page plan with its cost, and builds only after you approve it.