Repository navigation
Fold recursive-writer's tested rules into editor and writing-planner - #825
Merged
Merged
Conversation
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.
recursive-writer (the manager plus seven
rw-*modules, about 24k words and 2k lines of Python) is a second writing pipeline next todoc-author→writing-planner→editor. Evaluations run on 2026-11-11 tested what it adds. This PR moves the parts that showed a gain into the existing skills, so editor can be tested with them. Therw-*skills stay untouched for now.What the evaluations found
flow-custom-elements.mdxfrom one task description and one verified fact pack, scored blind against the lead writer's review of the real rw draft. The current workflow, in both runs, explained SDK code detail that belongs to the iOS article and described what the UI already shows. Adding rw's reader-question tags and heading tree fixed the first in both runs and the second in three of four judge calls, and cut length by about 10%. rw's full planning scored about the same as the borrowed rules, at twice the time.What this PR changes
act,see,edge,owner), builds the heading tree with a path line per section, and limits limitations and troubleshooting to what a reader would hit.references/plan-templates.mdcarries the path lines and a Left out list. Source: rw-questions, rw-plan, and rw-plan's structure brief.references/product-terms.md(Adapty terms and domain rules, loaded on every review). Tested: the new editor caught 8 of 8 planted wrong terms in each of 3 runs, the old one 4–6, with no correct term flagged by either. Source: rw's07-terms,product-terms.md,domain-rules.md.references/multi-review.md). Two reviewers per role (mobile developer; Adapty developer who checks every behavior claim against the transformer, frontend, backend and SDK code; editor; product manager), then one merge into a final review.scripts/lint-prose.mjs.editor/references/review-comments.md, a comments mode in editor, the lead writer's standing rules in editor's Area 12 andproduct-terms.md, and one line inreview-assistantthat loads the new reference.Handling review comments
What went wrong before
An analysis of 280 review threads from the lead writer, on the 34 most recent PRs they reviewed for other writers:
What the new rules do
editor/references/review-comments.mdcovers:The new reference also maps the lead writer's 13 standing rules to where editor now carries each one. Seven of them are new in editor's Area 12:
Area 8 also gains a line against new untested snippets, and
product-terms.mdnow says Apple Ads and Adapty SDK.Conflicting rules: decisions
Where editor and recursive-writer gave opposite rules
Word rules
Rules 1–3 come from recursive-writer's personal lint file (
lib/tools/extra-rules.mjs), not from its shared check library.1. "lets you"
output-templates.mdchanged the same way.lint-prose.mjshas a newbanned-lets-yourule that flags both phrases on changed lines only (59 existing articles use them).2. Possessives
3. "provides" and "these X:"
Structure rules
4. Locating a control by screen position
5. When steps get numbered
6. What an intro opens with
7. Mixing heading shapes
article-structure.mdand writing-planner now say: one shape by default; a reference section among task sections keeps its noun heading; a reference section never takes a task heading, and a task section never takes a noun heading.9. Passive voice
10. Sections: entry points or continuations
Process rules
11. How fixes get approved
12. Order of findings
13. Style-only suggestions
14. When the user corrects a proposal
Flow & Paywall Builder names
8 / B1. The builder's full name
mainsaid "Flow Builder". recursive-writer's glossary says Flow & Paywall Builder (capital B, ampersand), in full on first mention and wherever it doesn't hurt readability.B2. Later mentions
editor/references/product-terms.md.B3. The deprecated builder
editor/references/product-terms.md.B4. Text about both builders
editor/references/product-terms.md.B5. "Flow" for a sequence of steps
editor/references/product-terms.md.Not kept
Next steps (not in this PR)
rw-*modules, in a separate PR. Before deleting, decide on the parts no evaluation tested:sync.py, snapshots): keep the scripts only if rewording of hand-fixed text is a real problem.suggestionblocks, dependent comments): move into review-assistant only if it trips on those cases.