Skip to content

Doc rewrite drafts: rules vs briefing vs hybrid (for review) - #1

Draft
joncooper wants to merge 2 commits into
mainfrom
docs-rewrite-drafts
Draft

joncooper wants to merge 2 commits into
mainfrom
docs-rewrite-drafts

Conversation

@joncooper

Copy link
Copy Markdown
Owner

Three full rewrites of the README and design docs, side by side, so we can pick a direction by reading rather than guessing. Not meant to merge as is: once we choose, the winner gets promoted into docs/ and README.md, and these draft directories get deleted.

Each directory is the complete set (README plus architecture, security, lab-lifecycle, local-dev), produced by a clean-context agent under one guide:

  • docs-draft-v2/ followed the distilled doc-writing rules.
  • docs-draft-v3/ followed the foundational research briefing (pushed harder on brevity and full-sentence prose).
  • docs-draft-v4/ is the hand-finished hybrid: the stronger half of each, then iterated through a skeptical reader-test and a final editorial pass.

How to review: open the same file across the three directories and compare, or just read docs-draft-v4/ and comment on what to change. Inline comments are ideal; I will iterate on them.

For reference, the live v1.0 docs and the optional lint setup live on a separate branch (docs-lint-enforcement), not here.

Two full rewrites of README + the four design docs, each produced by a
clean-context Opus subagent following one guide:
- docs-draft-v2/ follows the distilled doc-writing rules
- docs-draft-v3/ follows the foundational research briefing

Source docs under docs/ are unchanged. For A/B review: pick one to
promote, then delete both draft dirs. Note: the v2 lifecycle draft also
fixes a stale 'no browser terminal' claim that v3 and the live doc keep.
Synthesized the stronger half of each prior draft, then iterated every doc
through a skeptical hiring-evaluator reader-test (clean-context Opus agents)
plus a final editorial pass. Carried in: accurate browser-terminal framing
in the lifecycle doc, IMDSv2 one-hop presented as the load-bearing control,
teardown moved ahead of the caveats, real numbers instead of hedges,
de-numbered flow headings, hook-first local-dev lede. Zero em dashes.
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