SpecSheriff
rule · _guidelines/tools/5 · s-k4nqjr96ux7a5m7

What the export, the guide and sheriff show write of a node

Checkedconfirmed by its owner

sheriff export and sheriff show write a node with every value its file holds for it. They write each link with its type, its direction, its ratio where it holds one, and the sid, address and title of the node at the other end.

sheriff guide writes each node of the guidelines as the export does, except its metadata.

Each of them writes a value that is not text, other than its links and its children, under its key as JSON. The export and the guide write a node's children after it, each under a heading one level deeper than its parent's; sheriff show writes the node alone.

Why

A person reads the specification in the export, since a structure a schema checks is hard to read (§s-kh8qcd5kxgh9z3j), and a person or an agent reads one node through sheriff show. A value either leaves out, such as a data record's fields, a rule's list or a decision taken on the node (§s-gqbj8849rf224qa), is one its reader never learns of and works without. A sid alone tells a reader nothing of the node it names.

An agent reads the guide whole before it works on the specification, to follow the guidelines: it needs each node as it binds, its links included, since a link may exempt a rule from implementation or narrow it. The metadata serves whoever changes a node, who reads it whole through sheriff show; written into the guide, it would only lengthen what every agent reads.

JSON is the form the file already holds a value in, so its reader learns no form of its own for it. The export and the guide keep the tree of the file they are written from, while sheriff show is asked for one node.

The links it makes

The links made to it

The tests bound to it