End the demo on a named provision, not on a score - #93
Merged
Conversation
Three changes from reviewing the recording.
Act 3 ended on an empty contract failing all 29 policies. True, and the
argument act 2 makes, but as an ending it reads as "the tool does not work" to
anyone who has not followed the reasoning. It now answers the 150 declarations
first, the way a reader would, and ends on:
Article 14 Controls Not Satisfied:
['Article 14(1)-(2) oversight designed into the system']
A named provision and the specific control. That is what the product is
actually differentiated on and what a reader can act on, where a count reads as
a grade.
Act 4, the metric gap report, is dropped. Enumerating the metrics nobody has
written an evaluator for is a good thing to show a contributor and a poor thing
to show someone deciding whether to adopt. The command stays in the
contributing section of the website page, where the audience is right.
The README cut is 36 seconds rather than 48. It autoplays above the fold, so it
has to be watchable before a reader decides to scroll. The page cut keeps its
framing line and runs about 70 seconds, where a reader has chosen to watch.
Typos now fire on a quarter of commands rather than half, which reads as a
person typing rather than as someone who cannot type.
Highlights re-verified by replaying both casts through a VT emulator: every row
carrying a highlighted phrase matches what the command actually printed.
github-actions
Bot
added
📝 documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three changes from your review.
Act 3 ended on
0 green, 29 redTrue, and it is the argument act 2 makes, but as an ending it reads as the tool does not work to anyone who has not followed the reasoning.
It now answers the 150 declarations first, the way a reader actually would, and ends on:
A named provision and the specific control outstanding. That is where this tooling is differentiated: a count is a grade, a provision is something you can act on.
Answering the declarations is done by
_answer_declarations, which takes field types from GOPAL's coverage data where it has inferred one and from the field name otherwise. A guard refuses to record if fewer than 100 of the 150 get answered, since that would mean the scaffold shape changed and the act would silently go back to showing an unanswered contract.Act 4 is gone
The metric gap report is a good thing to show a contributor and a poor thing to show someone deciding whether to adopt. It stays as a command in the contributing section of the page, where the audience is right.
Pacing
The README cut also drops its framing line, since it autoplays above the fold and has to be watchable before a reader decides to scroll. The page cut keeps it.
Verification
Both casts replayed through a VT emulator: every row carrying a highlighted phrase matches what the command actually printed, including the new
Article 14(1)-(2)sweep. 216 tests pass.Pairs with website#36.