Documents

Board documentation

What board documentation is

A board's documentation is one page of text on the board that tells people how to work on it: what to do first, how to answer, when things are due and who to ask. It sits in the board's own menu, so the help is right where the work is.

Every board can have documentation, from Compliance 2.0, findings and safety walks boards to Insurance, Claims and Frameworks and Controls. New boards start with it switched on. Boards created before documentation existed have it off until a board admin switches it on.

To write a page that is not about one board, such as how a whole process works or what the boards in a folder are for, use a Document board instead.

Switch the documentation on or off

  1. Open the board's Settings.
  2. Under Documentation, switch Show the Documentation page on or off and click Save.

While it is on, Documentation comes first in the board's menu in the sidebar. Switching it off hides the page. Its text and history are kept, so switching it back on brings it back as it was.

Give the page its own name

The board's menu calls the page Documentation until you name it. Under Documentation in the board's Settings, type a name in Name in the menu, such as How we work or Start here, and click Save. The menu and the page's title use the new name. Empty the field to call it Documentation again.

Write the documentation

Open Documentation and click Write the documentation, or Edit documentation once it has text. Write as you would in any text field: select text to make it a heading, a list or a link, add a table, or drag an image onto the page.

Nothing is saved until you click Save changes. Cancel throws your changes away, after asking first.

If someone else saves the documentation while you are editing, your save is stopped and you are told who saved. Your text stays where it is: look at their version in History, or click Save anyway to save yours over it.

See every version

Every save is kept. Click the clock in the top bar to open History and see who saved each version and when. Choose a version to compare it with the one before it. People who can edit the documentation can bring back an earlier version with Restore this version, which saves it as a new version.

Saving the documentation, switching it on or off and renaming it are recorded in the board's activity log.

Who can read and edit

WhoCan
Everyone who can open the boardRead the documentation and its history.
People who can manage the board's settingsAlso switch it on or off, name it, edit it and restore earlier versions.

To let someone write the documentation, give them a role on the board that includes Manage settings. See How access is controlled.

Board documentation and AI agents

AI agents connected to 21RISK read a board's documentation before they work on the board, so they can answer how-to questions with your own instructions. With the board's settings permission, an agent can also save a new version, which shows in the history like any other.