Skip to content

fix(doc-slop): require affirmative first-time-reader checks - #655

Merged
shunk031 merged 1 commit into
mainfrom
fix/doc-slop-judge-first-time-reader
Aug 20, 2026
Merged

fix(doc-slop): require affirmative first-time-reader checks#655
shunk031 merged 1 commit into
mainfrom
fix/doc-slop-judge-first-time-reader

Conversation

@shunk031

@shunk031 shunk031 commented Aug 19, 2026

Copy link
Copy Markdown
Owner

The question is whether a researcher can understand a report on first reading with no project context. The method is to read only the report text and examine its opening, terminology, counts, section titles, and reader focus. Here, English pidgin means English concept nouns inserted into Japanese prose without a Japanese gloss. The result is that a clear report is readable, while English pidgin and audit or process narration are not. The consequence is direct: unclear reports need rewriting before publication.

What must a clear report explain?

  • Its opening states the question, method, result, and consequence in plain language.
  • Its Japanese terms and units are defined, and every count names its object.
  • Its section titles explain what question each section answers.
  • It explains the result to the reader instead of narrating audits, repository mechanics, or auditor instructions.

Which examples are clear?

  • A report that leaves an English concept noun in Japanese prose is not clear and needs rewriting.
  • A report with a plain opening and defined terms is clear.
  • A report whose title names an internal stage and hardware mode instead of its question, and whose prose addresses auditors, is not clear.

What action follows the result?

Publish a report when a new reader can follow its question and evidence in plain language. Otherwise, rewrite the named passage until the report explains the subject to that reader.

How should this change be coordinated?

A sibling branch, feat/textlint-markdown-gate, also modifies scripts/doc_slop_review.py in the deterministic tier. This branch changes only the judge-side invocation and result parsing. The changes should reconcile when merged; whichever branch lands second must update its branch and re-verify all checks on the resulting head.

Merge-order caveat

PRs #658 and #661 also touch scripts/doc_slop_review.py and remain open. This PR changes only the judge-side invocation and result parsing; those sibling branches will update-branch after this PR lands, and the branch that lands second must re-verify its checks on the resulting head.

Require the blind judge to answer five reader-first checks and quote each failed check. Add small pidgin, clean, and process-metadata fixtures covering the new contract.

Co-authored-by: Codex <noreply@openai.com>
@shunk031
shunk031 force-pushed the fix/doc-slop-judge-first-time-reader branch from 8bf0e34 to 794117c Compare August 20, 2026 02:05
@shunk031
shunk031 merged commit f211f46 into main Aug 20, 2026
4 checks passed
@shunk031
shunk031 deleted the fix/doc-slop-judge-first-time-reader branch August 20, 2026 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant