The WorkMap

The WorkMap draws a project as a diagram. The project sits at the top, paths of work run down under it, and each path holds one card per feature. Terminals bind to those cards, so the map is also where finished work gets filed.

What the diagram holds

The box at the top carries the project name. Each path runs down its own column, and each card on a path is one feature.

A card shows the feature name, a description and its requirements. A requirement is one line of work with a position such as 1.2.1, which reads as path 1, feature 2, requirement 1. The foot of the card has a progress bar and the totals recorded against the feature, which are tokens, commits and time.

A card takes its color from its requirements. When every requirement is shipped, the card reads complete. When every one is blocked, it reads blocked. Anything else reads pending. A requirement whose work was later reverted is marked deprecated. It stays on the card as a record and stops counting toward progress.

Opening the WorkMap

Press WorkMap on the top bar. Hovering the button shows the diagram in miniature. The window always names its project, as in WorkMap: Project 1, even before the project has a map of its own.

Drag any corner to resize the window, and it opens at that size next time. The close button, Escape or a click outside the window closes it.

From a terminal, press the WorkMap mark in the terminal head. It opens that terminal's card in a small popup, and View in WorkMap at the bottom of the popup opens the window centered on the card.

Moving around

The toolbar at the bottom of the window has zoom out, the zoom percentage and zoom in. Click the percentage to go back to 100 percent. The window opens at 86 percent, and zoom runs from 25 to 200 percent.

• Hold Ctrl and turn the wheel to zoom around the pointer. The wheel on its own scrolls.
• The navigation button on the toolbar decides how the canvas pans. With it off, which is the default, drag empty space to pan. With it on, the canvas glides along when the pointer nears an edge of the window. The choice is remembered.
• Below 45 percent, cards shrink to their position and title. Below 30 percent they shrink to the position alone, so a large map stays readable. At the title size, clicking a card shows it full size and opens its panel.
• Undo and redo sit next to the zoom controls.

The toolbar also opens the project's conversations, covered in Conversations, and the WorkMap settings.

The HUD cards

Two cards float over the top of the canvas at a fixed size, so zooming never makes them unreadable.

• The left card shows the project totals. These are Tokens in and out, Commits, Lines and Time.
• The right card has the Filter button and a donut that shows how much of the map is completed, pending and blocked.

The filter lists Completed, Pending and Blocked, and the button shows how many groups are filtered out. At full zoom, unticking a group shrinks its cards to capsules. Zoomed out, it dims them instead, so the layout does not move while you look over the whole map.

When a card scrolls under one of these two, the floating card fades out and lets clicks through to the card below, so it never covers what you are reading.

Editing the map

You can edit the map whether or not a model drew it.

• Click a description to edit it in place. Clicking away or pressing Escape saves it. A card with no description reads Add a description….
• + requirement at the end of the requirement list adds one and opens it for editing.
• Each path has a control to add a feature to it. The blank space on either side of the tree adds a new path on that side.
• Drag a card up or down its own path to reorder it.
• The card header has a button that minimizes the card to a capsule and a trash icon that deletes it.

Positions are renumbered as you edit, so the numbers on the cards always match the tree. Changing a single requirement is covered in Nodes and requirements.

Terminals and nodes

Each terminal is bound to one feature. The WorkMap mark in the terminal head shows that feature's position, and pressing it opens the feature's card in a popup.

All nodes in that popup lists what the terminal can pick up, under Select a feature node to work on, with the most recently touched first. more shows the rest. A terminal that has already run work stays bound where it is. It can still browse the list, and the popup says this terminal is already linked to its work.

The same popup has Include in builds, which decides whether this terminal's work goes into combined builds. See The build queue.

Work can also start from the diagram.

• Hover a requirement and press its play control. It runs in a terminal bound to that feature, with a prompt that reads Start work on this requirement and the requirement text, or Continue the work on this requirement when it was worked before. If no terminal is bound to the feature yet, a new one opens.
• A pending feature has a play control in its header. It runs the feature's first requirement that is not shipped yet, the same way.
• Right-click a path or a card and choose Open terminal on this path. It opens a terminal on that feature, or uses the one already bound to it, closes the WorkMap and attaches the feature's context doc when it has one.

Finished work comes back to the map. Commits attach to the requirement the run worked on, and the conversation is filed under the feature. See Conversations and Nodes and requirements.

Settings

The gear on the toolbar opens Settings > WorkMap.

The spacing and font rows apply to the open diagram as you change them.