Seiso Convention

Appearance

Version 0.2.0

Changelog ​

Changes to the Seiso Convention Specification. The specification is versioned independently of the seiso crate, whose releases carry their own notes; its Versioning section defines the numbers. Each released version is published at https://seiso.fog.moe/<version>/ and at the spec-v<version> tag of this repository. This file follows Keep a Changelog.

Unreleased ​

0.2.0 - 2026-10-01 ​

Added ​

  • A worked example of a conversation remnant without a requester phrase: a request restated as a negative clause, its revision, and a negative statement that stays. The judgments name the KIND-6 decision.
  • A worked example of a measurement beside a comparative claim in a long-lived document: an undated figure that breaks POINTER-1, a revision that points to the dated record, and a dated figure that stays.
  • A record of measurements or of an investigation is classified as a changelog, or as an adr when its subject is a decision and its tradeoffs.

Changed ​

  • KIND-6 also forbids narrating how the work a long-lived document describes was produced, including attempts and options that the result replaced, and permits describing earlier behavior that the reader can still meet. The worked examples show both.

0.1.1 - 2026-10-01 ​

Changed ​

  • The adoption guide's agent snippet links to the adopted version on seiso.fog.moe instead of its spec-v<version> tag on GitHub, and this changelog names the site.

0.1.0 - 2026-10-01 ​

Added ​

  • The specification, restating the convention that seiso has documented since 0.1.0 as requirements with stable identifiers: document kinds (KIND-1 to KIND-8), facts and authority (FACT-1 to FACT-6), pointers and changing information (POINTER-1 to POINTER-3), exceptions (EXCEPTION-1 to EXCEPTION-3), and conformance for documentation sets and checkers (CONFORMANCE-1 to CONFORMANCE-6).
  • A table of which requirements a checker can establish completely, in part, or not at all.
  • A versioning section that defines which changes increment MAJOR, MINOR, and PATCH, and that a released version does not change.
  • A section on the relation to Diátaxis and to the formats of changelogs and decision records.
  • Worked examples covering a how-to, a reference page, a decision record, and a plan, with kind assignment by frontmatter and by mapping, boundary cases, exceptions, and judgments.
  • An adoption guide with an instruction snippet for coding agents.