docs(openkal): the design record in academic register, and current through 0.4 - #463
Merged
Conversation
…rough 0.4 The design document was written across four rounds and accumulated the register of working notes: emphasis carried by symbols rather than by sentences, second person, and colloquial phrasing. It is rewritten as declarative prose. No technical claim is removed and no measurement is dropped; the changes are to how the document reads, and to what it covers. Three substantive additions accompany the rewrite. A summary places the eight assessment dimensions at the head of the document, each with the section that argues it: architecture, stability, simplicity, consumer experience, compatibility, portability, consistency, and upgrade without disruption. Previously the dimensions were argued in the text and nowhere collected, so the document could not be read as an assessment. The record now runs through 0.4 rather than stopping at 0.2. Three sections are added: what the extension to eight interfaces derived and from what; the two rules 0.4 states that 0.3 did not; and what a second implementation and a C library above the stack establish — together with what they do not, since both implementations were written by one author and their agreement on the argument vector was both unanimous and wrong. A section on consistency records that openkal was implemented twice without modifying mcpp, and enumerates the mechanisms used: conditional dependencies, platform-selected development dependencies, absence of a module as a compile-time capability check, and a static comparison of the exported surface. None is new. That every declaration a project makes resides in its `mcpp.toml` is the constraint under which the capability configuration file was removed. The completeness plan gains the dimension it was missing — consistency — and a record of where the work stands against its own five criteria for completeness. Two are met, one is partly met, one is not met and not attempted, and one is not met for a reason worth stating: a second implementation by the same author is not the second implementation that criterion asks for.
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
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.
The design document was written across four rounds and accumulated the register
of working notes: emphasis carried by symbols rather than by sentences, second
person, and colloquial phrasing. It is rewritten as declarative prose. No
technical claim is removed and no measurement is dropped; the changes are to how
the document reads, and to what it covers.
Three substantive additions accompany the rewrite.
A summary places the eight assessment dimensions at the head of the document,
each with the section that argues it: architecture, stability, simplicity,
consumer experience, compatibility, portability, consistency, and upgrade without
disruption. Previously the dimensions were argued in the text and nowhere
collected, so the document could not be read as an assessment.
The record now runs through 0.4 rather than stopping at 0.2. Three sections are
added: what the extension to eight interfaces derived and from what; the two
rules 0.4 states that 0.3 did not; and what a second implementation and a C
library above the stack establish — together with what they do not, since both
implementations were written by one author and their agreement on the argument
vector was both unanimous and wrong.
A section on consistency records that openkal was implemented twice without
modifying mcpp, and enumerates the mechanisms used: conditional dependencies,
platform-selected development dependencies, absence of a module as a compile-time
capability check, and a static comparison of the exported surface. None is new.
That every declaration a project makes resides in its
mcpp.tomlis theconstraint under which the capability configuration file was removed.
The completeness plan gains the dimension it was missing — consistency — and a
record of where the work stands against its own five criteria for completeness.
Two are met, one is partly met, one is not met and not attempted, and one is not
met for a reason worth stating: a second implementation by the same author is not
the second implementation that criterion asks for.