From 1d09e32d4a73f1663bb2ea8380eba950f09b7fbe Mon Sep 17 00:00:00 2001 From: Rook-CodeVolt <260194005+Rook-CodeVolt@users.noreply.github.com> Date: Sun, 30 Aug 2026 11:15:56 +0100 Subject: [PATCH] docs: require natural public copy --- PUBLICATION_POLICY.md | 6 ++++++ README.md | 8 ++++---- scripts/validate_public_content.py | 6 +++++- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/PUBLICATION_POLICY.md b/PUBLICATION_POLICY.md index 51075e6..01f13d3 100644 --- a/PUBLICATION_POLICY.md +++ b/PUBLICATION_POLICY.md @@ -14,6 +14,12 @@ This repository is a curated public evidence layer, not a mirror of CodeVolt's i The maintainer must review architecture descriptions, screenshots, incident lessons, security-related observations, measurements, customer-derived material and statements about future capabilities. Remove identifying detail only when the remaining material is still accurate and useful; otherwise keep it private. +## Editorial quality + +Public copy must read naturally and sound like the person or maintainer responsible for it. Remove chatbot carry-over, stock promotional language, inflated significance, formulaic contrasts, repetitive three-part lists, rhetorical questions that answer themselves, generic upbeat endings and unnecessary formatting. Avoid repeated em dashes, bold labels, emojis and headings that make short material look templated. + +Do not add fake typos, invented opinions or artificial quirks to imitate a person. Use specific facts, ordinary words and natural sentence rhythm. Read the final draft aloud. If it sounds generated or assembled, rewrite it before publication. + ## Never publish here - Credentials, tokens, secrets or private keys diff --git a/README.md b/README.md index 6895f7a..c039c9f 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,10 @@ It is not a live operations feed, a complete description of CodeVolt, a customer ## Contents -- [`checklists/proposed-change-review.md`](checklists/proposed-change-review.md) — bound a proposed change before reviewing it. -- [`checklists/one-file-fix.md`](checklists/one-file-fix.md) — keep a genuinely contained fix contained. -- [`checklists/small-technical-handover.md`](checklists/small-technical-handover.md) — hand over what changed, how it was checked and how to undo it. -- [`templates/public-work-note.md`](templates/public-work-note.md) — prepare a restrained public note backed by public evidence. +- [`checklists/proposed-change-review.md`](checklists/proposed-change-review.md): bound a proposed change before reviewing it. +- [`checklists/one-file-fix.md`](checklists/one-file-fix.md): keep a genuinely contained fix contained. +- [`checklists/small-technical-handover.md`](checklists/small-technical-handover.md): hand over what changed, how it was checked and how to undo it. +- [`templates/public-work-note.md`](templates/public-work-note.md): prepare a restrained public note backed by public evidence. ## Use diff --git a/scripts/validate_public_content.py b/scripts/validate_public_content.py index 7f1716d..8679a9b 100644 --- a/scripts/validate_public_content.py +++ b/scripts/validate_public_content.py @@ -28,7 +28,11 @@ "external contractor": "internal staffing disclosure", "external agent": "internal staffing disclosure", "CONTRACTOR_X_BRIEF": "internal publishing-operations reference", - "Hannah at CodeVolt": "individual framing instead of the CodeVolt team", + "I hope this helps": "chatbot carry-over", + "Let me know if you'd like": "chatbot carry-over", + "Let's dive in": "formulaic introduction", + "Here's what you need to know": "formulaic introduction", + "As an AI": "chatbot self-reference", } LINK_RE = re.compile(r"!?\[[^\]]*\]\(([^)]+)\)")