Browse topics

The document register

Keep every specification, plan and sign-off in one register, with its version, author, reviewer, status and file.

Who can do this
  • Admin
  • Project manager
  • Functional lead
  • Technical lead
  • Consultant

Updated

Open this in the app
On this page

The document register is the project's list of important documents: specifications, plans, test results, minutes and sign-offs, with their review status. Open it from the project menu: Documents.

What it's for

The register answers which version of a document is current, who wrote it, who reviewed it and whether it is approved. Each entry can hold the file itself. Two charts at the top show Documents by type and Documents by status.

Before you start

Before you add a document

  • The project's plan includes Documents (Professional, Enterprise or a personal plan)
  • Your role can upload documents
  • The file is PDF, Word, Excel, PowerPoint, text, CSV, XML or ZIP
  • The file is 50 MB or smaller

How to add a document

  1. Start a new entry

    On the Documents tab select Add document.

  2. Attach the file

    Under File, drop the file onto the box or select Choose a file. You can also add the entry without a file and attach one later.

  3. Identify it

    Enter the Title and choose the Doc type. Both are required. Add the Version (such as v1.0), Workstream and Phase.

  4. Record ownership

    Fill in the Author and Reviewer, and set the Status: Draft, In review, Approved, Superseded or Archived.

  5. Link and save

    Optionally pick a Linked WRICEF object and a Linked task, add Additional notes, then select Add document. The app gives it an ID such as ABC-DOC-018.

Replacing and downloading files

  • To replace the file, open the entry and select Replace file. Under it you will see Upload a new file to replace it.
  • To download a file, use the download button on the row. Files are private: the button fetches a short-lived link for you.
  • Anyone who can see the Documents tab can download its files.

Finding a document

Search by title or doc ID, and filter by type, workstream, phase or status. The table shows each entry's doc ID, title, type, workstream, phase, version, author, status and file. Superseded documents are struck through, so the current version stands out.

Specifications from WRICEF objects

Functional and technical specifications for WRICEF objects live in this register too. When someone uploads a specification on a WRICEF object, the app adds it to the register as a Draft, linked to that object. Uploading a newer version marks the old one Superseded, so the history stays in the register. You can also link a document that is already in the register to an object. See WRICEF specifications.

Asking for sign-off

A saved document shows a Signatures panel. Use it to ask named project members to sign the document. Each signer is emailed when it is their turn. The signature fingerprint covers the file itself, so a changed file shows up. See E-signatures.

Who can do this

Admins, project managers, functional leads, technical leads and consultants can add documents. Admins, project managers, functional leads and technical leads can edit them. Only admins and project managers can delete a document. See Roles and permissions.

Still stuck?

Email us with the page you were on and what you tried, and we will help you finish it.