1.1 Scope
This document defines how the technical documents of Peios are written and how they are read. It governs two classes of document:
- the specifications of this anthology — the four books that state what must be true for a Peios system and for the parties that interoperate with one; and
- the technical reference manuals — the per-component books that describe exhaustively how one piece of Peios actually behaves.
It covers normative language, the structure a document of each class takes, how any part of either is cited, and the style rules both share.
1.1.1 What this document does not cover #
- Task documentation — the tutorial and how-to material written for people using or building on Peios. That has its own house style, maintained separately, and neither the normative apparatus of a specification nor the exhaustiveness of a reference manual applies to it.
- Any behaviour of Peios itself. Nothing here specifies what a Peios system does. This document constrains documents.
- The renderer. The static site generator that builds these books supplies the chapter and article numbering this document's addressing scheme relies on, and is specified separately.
- Editorial process. How a document is reviewed, by whom, and when it is considered ready are project conventions rather than document conventions.
1.1.2 Position in the anthology #
This document sits ahead of the four specification books because it is read first. It is not itself a specification: it defines no Peios behaviour, and no implementation conforms to it. What conforms to it are documents.