Skip to content

Page template

Copy this file to start any new page, then delete this paragraph. Keep the section headings and their order exactly as they are — a reader who has read one page should know where to look on every other page.

The nine sections below are not arbitrary. Sections 2, 4, 5 and 6 are the four things the documentation brief explicitly requires: features, the modules it uses, how it is configured, and how it is used.

1. Purpose

Two or three sentences in plain business language, no Odoo jargon. This is the part a salesperson can read aloud to a client. Answer: what problem does this solve, and for whom?

2. Features

A flat bulleted list of capabilities, each one a thing the client gets. Write outcomes, not field names.

  • Good: "Invoices can be issued in a foreign currency and revalued at month end."
  • Bad: "Adds currency_id to account.move."

3. Where to find it

The menu path a user actually clicks, plus the technical name in brackets.

  • Menu: Accounting → Customers → Invoices
  • Technical name: account
  • Depends on being installed: list any module that must be installed first

4. Modules used

A table, always with the tier, because tier drives support and licensing.

Module Tier Why it is needed
account Odoo core Journal entries, taxes, chart of accounts
base_accounting_kit Third-party (Cybrosys) Financial reports absent from core Community
payroll_custom_module NestERP custom Tanzanian statutory payroll rules

Tiers are exactly three: Odoo core, Third-party (vendor name), NestERP custom.

5. Configuration

Numbered steps, in the order someone setting up a fresh database must do them. State prerequisites before steps. Name the exact setting label as it appears in the UI.

  1. Prerequisite: the company's country must be set, or tax defaults will be wrong.
  2. Go to Settings → ... and enable ...
  3. Create the master data: ...

Configuration traps

Anything that silently breaks later if set wrongly goes here, not buried in prose.

6. How it's used

The day-to-day workflow, numbered, with the responsible role named on each step. This is the end-user manual section.

  1. Accountant — creates the invoice from Accounting → Customers → Invoices → New.
  2. Accountant — confirms it, which posts the journal entry and locks the number.
  3. Cashier — registers the payment and reconciles it against the bank statement.

Screenshot needed

Capture: Accounting → Customers → Invoices, a posted invoice in form view. Save to docs/assets/<page-name>/ and reference it here.

7. Access rights

Group Can do
Billing Create and post invoices, register payments
Billing Administrator Everything above, plus lock periods and edit the chart of accounts

Note any record rules that restrict visibility by company, branch, or department.

8. Version differences (16 / 17 / 18)

Only real, observed differences. If there are none, write "No functional differences across 16, 17 and 18." Do not pad this section.

Behaviour specific to 16.

Behaviour specific to 17.

Behaviour specific to 18.

9. Known limitations

Honest list. What this does not do, what a client will ask for and not get, and where a custom module is required to fill the gap. A documented limitation is a scoping tool; an undocumented one is a dispute during delivery.

Needs verification

Everything on this page that has not been confirmed against a live instance goes here, as a checklist, so it is visible rather than assumed.

  • item to confirm on the Thalia live instance