Skip to main content

Module shape

Module shape 

Source
Expand description

Shape: what a writing assistant changed in a person’s words, decided by code. The model proposes a requirement; this module computes which words of the proposal are the person’s and which were added, which of the person’s words were dropped, which sentences landed nowhere, which added numbers and terms no assumption explains, and what in the text makes it hard to test. Nothing here asks the model or believes it.

Structs§

Assumption
What the assistant says it introduced.
Coverage
Where one of the person’s sentences went.
Diff
The proposal’s stretches (yours or added) and the person’s (yours or dropped).
Finding
A writing-check hit.
Span
A stretch of text and its origin; the stretches of one text, in order, are that text exactly.

Enums§

Origin
Where a stretch of text came from.

Functions§

check
The writing check of text, a requirement (with its scenarios) when requirement: vague words, escape clauses, open-ended lists; for a requirement also a missing obligation word (MUST/SHALL), a When without a Then, and scenarios with no failure path. A fixed list, model-free.
coverage
Each sentence of original and the lines of proposal sharing at least half of its content words (at least one); a sentence with no content words (a greeting) is never dropped.
diff
Which words of proposal are original’s (the longest common subsequence of their words, case-insensitive) and which were added; which of original’s words were dropped. Separators follow the word before them.
sentences
The sentences of a person’s text: split at ., !, ? and line breaks; list markers dropped; empty ones skipped.
unexplained
Added numbers, quantities and quoted terms that no assumption’s words contain: what the assistant introduced without saying so.