Modules
A module is a piece of work bigger than a task and longer than a sprint: a feature, a migration, a launch. Tasks join a module, and the module shows how far along it is.
Creating a module needs the Pro plan. Reading them does not.
Modules are off by default on a new project. Turn them on in Settings, then Features.
Modules and sprints are independent
This is the thing to understand first. A module is not a big sprint and does not contain sprints.
- A sprint is a span of time. It answers "what are we doing for the next two weeks".
- A module is a body of work. It answers "how far along is the billing rewrite".
A task can be in a module and a sprint at the same time, and most are. A module usually spans several sprints. Nothing links the two except the tasks they share, which is why a module's progress does not reset when a sprint ends.
A task can also belong to more than one module.
What a module holds
- A name, unique within the project.
- A description.
- A start date and a target date.
- A status, which starts at Planned.
- Members, and the tasks assigned to it.
Progress
Progress is derived from the tasks, never typed in. The module counts its tasks by state group: completed, cancelled, started, unstarted and backlog, plus the points total.
The progress figure is completed tasks against the total, with cancelled tasks taken out of the denominator. Cancelling work you decided not to do should move a module forward, not hold it back.
Progress is independent of the status. A module marked Planned whose tasks are nearly all done will report nearly complete, because the tasks are the truth and the status is a label someone set.
Who can do what
| Action | Needs |
|---|---|
| Read modules and their progress | Any project member, guests included |
| Create, edit, archive, unarchive, add or remove tasks | Member or above |
| Delete a module | Admin |
| Create a module at all | The Pro plan |
Only creating is gated. A workspace that drops below Pro keeps its modules, and the tab offers an upgrade rather than opening.
Troubleshooting
| What you see | What it means |
|---|---|
| "Module with this name already exists in this project" | Module names are unique per project. |
| "Name is required" | A module needs a name before anything else. |
| An upgrade screen on the Modules tab | The workspace is below Pro. Existing modules are intact. |
| "Member access required" | Guests can read a module but not change one. |
| "Admin access required" | Deleting a module needs admin. Archiving only needs Member. |
| The module is missing from the roadmap | It needs both a start date and a target date to be drawn. |
| Progress does not match what you expect | Cancelled tasks are left out of the total, and the status label does not affect the figure. |