Describe your applications 2 min read

Handbook

The written reference for an application or component — architecture pages, runbooks, decisions, and files

Updated
On this page

The Handbook is the written reference for an application or a component. On an application it holds architecture pages, runbooks, decisions, and files. On a component it holds that component’s runbooks and files.

Open the Handbook tab on the application or component.

Categories on an application

The categories are All, Architecture, Runbooks, Decisions, and Files.

Architecture is the default. Select All to list every page on the application. The other categories focus on one type:

Category What you’ll find More
Architecture Pages about how the system is put together, plus views from the scan until those pages exist Architecture pages
Runbooks How-to pages for operating the system Runbooks
Decisions Formal choices about what you build, how you build it, and how you work, linked to this application Decisions
Files Documents uploaded to this application Artifacts

Categories on a component

A component’s Handbook has Runbooks and Files for that component. An application’s Runbooks list also includes its components’ runbooks.

Older tabs

The Handbook replaces the older Knowledge, Architecture, Decisions, and Artifacts tabs on the application, and the Knowledge tab on a component. Bookmarks to those tabs still open the matching Handbook category.