self-evolve-framework 1.0.7 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -8
- package/bin/cli.js +63 -35
- package/package.json +1 -1
- package/template/rules/CodeGraph.mdc +23 -0
- package/template/rules/Svelte_5.mdc +167 -0
- package/template/rules/Svelte_Flow.mdc +176 -0
- package/template/rules/Tailwind_CSS_v4.mdc +187 -0
- package/template/rules/Tauri.mdc +145 -0
- package/template/rules/app-error-pattern.mdc +65 -0
- package/template/rules/invoke-safe-pattern.mdc +53 -0
- package/template/rules/js.mdc +10 -0
- package/template/rules/powershell.mdc +9 -0
- package/template/rules/self-evolve.mdc +4 -4
- package/template/rules//346/227/245/345/277/227.mdc +15 -0
- package/template/rules//350/257/267/346/261/202.mdc +49 -0
- package/template/skills/caveman/SKILL.md +49 -0
- package/template/skills/check/SKILL.md +393 -0
- package/template/skills/check/agents/reviewer-architecture.md +39 -0
- package/template/skills/check/agents/reviewer-security.md +39 -0
- package/template/skills/check/references/persona-catalog.md +56 -0
- package/template/skills/check/references/project-context.md +120 -0
- package/template/skills/check/references/public-reply.md +14 -0
- package/template/skills/check/scripts/audit_signals.py +666 -0
- package/template/skills/check/scripts/run-tests.sh +19 -0
- package/template/skills/design/SKILL.md +173 -0
- package/template/skills/design/references/design-aesthetic-quality.md +67 -0
- package/template/skills/design/references/design-data-viz.md +34 -0
- package/template/skills/design/references/design-reference.md +295 -0
- package/template/skills/design/references/design-tokens.md +45 -0
- package/template/skills/design/references/design-traps.md +43 -0
- package/template/skills/design-an-interface/SKILL.md +94 -0
- package/template/skills/diagnose/SKILL.md +117 -0
- package/template/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/template/skills/edit-article/SKILL.md +14 -0
- package/template/skills/git-guardrails-claude-code/SKILL.md +95 -0
- package/template/skills/git-guardrails-claude-code/scripts/block-dangerous-git.sh +25 -0
- package/template/skills/grill-me/SKILL.md +10 -0
- package/template/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/template/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/template/skills/grill-with-docs/SKILL.md +88 -0
- package/template/skills/handoff/SKILL.md +15 -0
- package/template/skills/health/SKILL.md +260 -0
- package/template/skills/health/agents/inspector-context.md +119 -0
- package/template/skills/health/agents/inspector-control.md +84 -0
- package/template/skills/health/agents/inspector-maintainability.md +55 -0
- package/template/skills/health/scripts/check-agent-context.sh +5 -0
- package/template/skills/health/scripts/check-doc-refs.sh +8 -0
- package/template/skills/health/scripts/check-maintainability.sh +8 -0
- package/template/skills/health/scripts/check-verifier-output.sh +5 -0
- package/template/skills/health/scripts/check_agent_context.py +444 -0
- package/template/skills/health/scripts/check_doc_refs.py +110 -0
- package/template/skills/health/scripts/check_maintainability.py +635 -0
- package/template/skills/health/scripts/check_verifier_output.py +116 -0
- package/template/skills/health/scripts/collect-data.sh +751 -0
- package/template/skills/hunt/SKILL.md +232 -0
- package/template/skills/hunt/references/failure-patterns.md +138 -0
- package/template/skills/hunt/references/ime-unicode.md +58 -0
- package/template/skills/hunt/references/logging-techniques.md +72 -0
- package/template/skills/hunt/references/rendering-debug.md +34 -0
- package/template/skills/impeccable/SKILL.md +47 -0
- package/template/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/template/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/template/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
- package/template/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/template/skills/improve-codebase-architecture/SKILL.md +81 -0
- package/template/skills/learn/SKILL.md +140 -0
- package/template/skills/migrate-to-shoehorn/SKILL.md +118 -0
- package/template/skills/obsidian-vault/SKILL.md +59 -0
- package/template/skills/prototype/LOGIC.md +79 -0
- package/template/skills/prototype/SKILL.md +30 -0
- package/template/skills/prototype/UI.md +112 -0
- package/template/skills/qa/SKILL.md +130 -0
- package/template/skills/read/SKILL.md +141 -0
- package/template/skills/read/references/read-methods.md +129 -0
- package/template/skills/read/scripts/fetch.sh +106 -0
- package/template/skills/read/scripts/fetch_feishu.py +251 -0
- package/template/skills/read/scripts/fetch_local.py +218 -0
- package/template/skills/read/scripts/fetch_weixin.py +107 -0
- package/template/skills/request-refactor-plan/SKILL.md +68 -0
- package/template/skills/review/SKILL.md +78 -0
- package/template/skills/rust-auto-fix/SKILL.md +94 -0
- package/template/skills/scaffold-exercises/SKILL.md +106 -0
- package/template/skills/sdd-dev/SKILL.md +114 -0
- package/template/skills/setup-matt-pocock-skills/SKILL.md +121 -0
- package/template/skills/setup-matt-pocock-skills/domain.md +51 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-github.md +22 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
- package/template/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
- package/template/skills/setup-pre-commit/SKILL.md +91 -0
- package/template/skills/skillopt-sleep/SKILL.md +1 -1
- package/template/skills/svelte-warnings-fix/SKILL.md +94 -0
- package/template/skills/tauri-nsis-installer-icon/SKILL.md +92 -0
- package/template/skills/tauri-nsis-installer-icon/references/tauri-nsis-schema.md +71 -0
- package/template/skills/tb/SKILL.md +62 -0
- package/template/skills/tdd/SKILL.md +109 -0
- package/template/skills/tdd/deep-modules.md +33 -0
- package/template/skills/tdd/interface-design.md +31 -0
- package/template/skills/tdd/mocking.md +59 -0
- package/template/skills/tdd/refactoring.md +10 -0
- package/template/skills/tdd/tests.md +61 -0
- package/template/skills/teach/GLOSSARY-FORMAT.md +35 -0
- package/template/skills/teach/LEARNING-RECORD-FORMAT.md +46 -0
- package/template/skills/teach/MISSION-FORMAT.md +31 -0
- package/template/skills/teach/RESOURCES-FORMAT.md +32 -0
- package/template/skills/teach/SKILL.md +91 -0
- package/template/skills/think/SKILL.md +184 -0
- package/template/skills/to-issues/SKILL.md +83 -0
- package/template/skills/to-prd/SKILL.md +74 -0
- package/template/skills/triage/AGENT-BRIEF.md +168 -0
- package/template/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/template/skills/triage/SKILL.md +103 -0
- package/template/skills/ubiquitous-language/SKILL.md +93 -0
- package/template/skills/ver/SKILL.md +62 -0
- package/template/skills/write/SKILL.md +209 -0
- package/template/skills/write/references/write-en.md +199 -0
- package/template/skills/write/references/write-product-localization.md +43 -0
- package/template/skills/write/references/write-zh-bilingual.md +59 -0
- package/template/skills/write/references/write-zh-prose.md +50 -0
- package/template/skills/write/references/write-zh-release-notes.md +40 -0
- package/template/skills/write/references/write-zh.md +721 -0
- package/template/skills/write-a-skill/SKILL.md +117 -0
- package/template/skills/writing-beats/SKILL.md +52 -0
- package/template/skills/writing-fragments/SKILL.md +75 -0
- package/template/skills/writing-shape/SKILL.md +64 -0
- package/template/skills/zoom-out/SKILL.md +7 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: write
|
|
3
|
+
description: "Rewrites and polishes prose in Chinese or English, removes AI-like wording, and reviews product localization copy while preserving intent for drafts, docs, release notes, launch copy, and social posts. Use when users ask 帮我写/改稿/润色/去AI味/写一段/审稿/本地化文案/tweet/rewrite/proofread. Not for code comments, commit messages, or inline docs."
|
|
4
|
+
when_to_use: "帮我写, 改稿, 润色, 去AI味, 写一段, 审稿, 文档review, 本地化文案, 多语言文案, i18n copy, localization copy, check this document, 推特, twitter, X推文, tweet, social post, 连贯性, 段落连贯, draft, edit text, proofread, sound natural, polish, rewrite"
|
|
5
|
+
dispatch_intent: "Writing, editing prose, polish, release notes, launch/social copy, remove AI tone"
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Write: Cut the AI Taste
|
|
9
|
+
|
|
10
|
+
Prefix your first line with 🥷 inline, not as its own paragraph.
|
|
11
|
+
|
|
12
|
+
**Update check (non-blocking).** Before starting, run `bash ../../scripts/check-update.sh` once; if it prints a line, relay it to the user, then continue. It runs at most once a day, only reads a public version file, sends no data, and fails silently.
|
|
13
|
+
|
|
14
|
+
Strip AI patterns from prose and rewrite it to sound human. Do not improve vocabulary; remove the performance of improvement.
|
|
15
|
+
|
|
16
|
+
## Outcome Contract
|
|
17
|
+
|
|
18
|
+
- Outcome: the prose preserves the author's intent while sounding natural for its audience and surface.
|
|
19
|
+
- Done when: meaning, factual claims, and structure are preserved unless the user asked to change them, and AI-like wording is removed.
|
|
20
|
+
- Evidence: supplied text, target audience, project style references, release or product state, and requested language.
|
|
21
|
+
- Output: the edited prose only, unless the user asked for notes, variants, or review comments.
|
|
22
|
+
|
|
23
|
+
## Core Stance
|
|
24
|
+
|
|
25
|
+
This skill is a catalog of smells, not a checklist to run top to bottom. Use it to recognize AI taste, then make judgment calls. The reference files (especially `write-zh.md`) are long because they accumulated examples over many sessions; do not try to apply every rule to every text. Applying more rules is not doing a better job.
|
|
26
|
+
|
|
27
|
+
- **Over-editing is failure, equal to under-editing.** If a sentence is already natural, clear, and stable, leave it. Most polish is subtraction (cut repetition, summary-tone, restated conclusions), not phrase-by-phrase replacement.
|
|
28
|
+
- **The author's voice wins.** Keep the author's existing colloquial words, cadence, and stance. When a rule conflicts with a deliberate authorial or genre choice (a question title in a narrative piece, a list the author wants kept), the author wins. Rules are defaults, not laws.
|
|
29
|
+
- **Banned-phrase lists and replacement tables are examples, not find-and-replace.** A flagged word that reads naturally in context stays. Match the smell, not the string.
|
|
30
|
+
- **Prefer fewer, stronger edits.** Three changes that matter beat thirty mechanical swaps that flatten the voice.
|
|
31
|
+
|
|
32
|
+
When distilling a new lesson into this skill, fold it into an existing principle instead of appending another banned phrase. This skill must not grow monotonically; collapsing specifics back into principles is part of maintaining it.
|
|
33
|
+
|
|
34
|
+
## Pre-flight
|
|
35
|
+
|
|
36
|
+
1. **Text present?** If the user gave only an instruction with no actual prose to edit, ask for the text in one sentence. Do not proceed.
|
|
37
|
+
2. **Audience locked?** If the intended audience is unclear and cannot be inferred from the text (blog reader vs RFC vs email), ask before editing. Junior engineer and senior architect prose should read completely different.
|
|
38
|
+
3. **Language detected from the text being edited**, not the user's command:
|
|
39
|
+
- Contains Chinese characters + release notes or social post mode → load `references/write-zh-release-notes.md`
|
|
40
|
+
- Contains Chinese characters + bilingual or translation review → load `references/write-zh-bilingual.md`
|
|
41
|
+
- Product/site/app localization review across multiple locales → load `references/write-product-localization.md`; also load `references/write-zh-bilingual.md` when Chinese copy is present
|
|
42
|
+
- Contains Chinese characters (default prose) → load `references/write-zh-prose.md` (quick rules); load `references/write-zh.md` for the full AI-taste pattern catalog
|
|
43
|
+
- Otherwise → load `references/write-en.md`
|
|
44
|
+
|
|
45
|
+
Read the loaded reference file. Then edit. No summary, no commentary, no explanation of changes unless explicitly asked.
|
|
46
|
+
|
|
47
|
+
## Durable Context Preflight
|
|
48
|
+
|
|
49
|
+
See [rules/durable-context.md](../../rules/durable-context.md) for when to read durable context, the read-order budget, and the memory-type mapping.
|
|
50
|
+
|
|
51
|
+
For `/write`, voice and format constraints are `decision`, `preference`, and `principle` entries; editing checks are `pattern` and `learning`. The supplied text, audience, project docs, current release state, and source material override memory. Durable preferences can set brevity, tone, and social-post shape. They do not override the hard rule to edit in place, keep meaning intact, and avoid change lists unless the user explicitly asks.
|
|
52
|
+
|
|
53
|
+
## Hard Rules
|
|
54
|
+
|
|
55
|
+
- **Meaning first, style second.** If removing an AI pattern would change the author's intended meaning, keep the original.
|
|
56
|
+
- **No silent restructuring.** Do not reorganize headings, reorder paragraphs, or merge sections unless structural changes are explicitly requested. Edit in place. (Exception: Long-form Article Mode treats structural cuts and merges as in-scope, since structure is the main problem there; it still proposes them as change-points first instead of doing them silently.)
|
|
57
|
+
- **Artifact-grounded claims.** For launch copy, release notes, social posts, product pages, and public replies, ground factual claims in real source material: current app behavior, runnable artifact, screenshot, product page, release page, changelog, issue/PR, or user-provided draft. Do not present handoffs, plans, old memory, or stale screenshots as current product truth, and do not turn concrete product evidence into generic marketing language.
|
|
58
|
+
- **No em-dash.** Never produce em-dash (U+2014 `—`) or en-dash (U+2013 `–`) in Chinese or English output. Em-dash is the strongest AI-tone fingerprint in this style of writing. Use commas, periods, colons, semicolons, or parentheses to break clauses. Hyphen-minus (`-`) inside compound words is allowed; replace it with a space or a period when possible. When editing a draft that contains em-dashes, replace every one before returning the text.
|
|
59
|
+
- **Stop after output.** Deliver the rewritten text. Do not append a list of changes, a justification, or a closer. (Exception: Long-form Article Mode returns change-points for review instead of a rewritten blob; see that mode.)
|
|
60
|
+
|
|
61
|
+
## Long-form Article Mode
|
|
62
|
+
|
|
63
|
+
Activate when: editing a Markdown article or file over ~300 lines, or one with multiple `##` sections plus tables and images (technical long-reads, blog posts, deep dives).
|
|
64
|
+
|
|
65
|
+
In long-form, the dominant problem is usually structural: the same checklist repeated across sections, prose that re-reads a table sitting right above it, list bloat, whole redundant sections. Sentence-level AI taste is the smaller half. A single in-place polish pass cannot see or fix the structural half, which is why a plain `/write` on a long article feels like it changed wording but left the bloat. This mode therefore overrides two Hard Rules: structural cuts and merges are in-scope, and the output is change-points for review, not a rewritten blob.
|
|
66
|
+
|
|
67
|
+
Workflow:
|
|
68
|
+
|
|
69
|
+
1. **Map first, read-only.** Before editing anything, read the whole article and list every `##` section, table, list, and image. Flag three structural problems: cross-section repetition (same checklist / judgment list / core claim in 2+ sections), table re-reading (a section whose prose walks the rows of the table above it), and whole redundant sections or paragraphs.
|
|
70
|
+
2. **Propose cuts as change-points.** Show before to after for each structural cut or merge and let the user pick the subset. Never delete a whole section or paragraph silently; confirm first, since it may hold a fact found nowhere else (see `references/write-zh.md` 删段之前先确认信息量).
|
|
71
|
+
3. **Then line-level de-AI**, section by section, per `references/write-zh.md`.
|
|
72
|
+
4. **Output is change-points, not a blob.** Show what changed so the user can review and keep their own hand-edits. Only return fully rewritten text when the user says 直接改 / just rewrite.
|
|
73
|
+
|
|
74
|
+
Do not single-pass rewrite a 40k-character article: it silently overwrites the author's hand-tuned phrasing and cannot be reviewed as a diff. See `references/write-zh.md` 结构级重复与表格复读(长文专项)for the matching content rules.
|
|
75
|
+
|
|
76
|
+
## Bilingual Review Mode
|
|
77
|
+
|
|
78
|
+
Activate when: mixed Chinese/English, "Chinese copywriting", "bilingual consistency", "release notes"
|
|
79
|
+
|
|
80
|
+
**Chinese rules** (from https://github.com/mzlogin/chinese-copywriting-guidelines):
|
|
81
|
+
- Space between Chinese and English characters (CN文字EN → CN 文字 EN)
|
|
82
|
+
- No mixing of punctuation (Chinese uses 、。?!;:, not commas/periods)
|
|
83
|
+
- Consistent terminology across all instances
|
|
84
|
+
|
|
85
|
+
**English in Chinese documents**: Flag unexplained English, suggest translation or add context.
|
|
86
|
+
|
|
87
|
+
**Bilingual pairs**: Confirm EN and CN versions convey the same meaning; mark translation loss.
|
|
88
|
+
|
|
89
|
+
## Product Localization Review Mode
|
|
90
|
+
|
|
91
|
+
Activate when: "本地化文案", "多语言文案", "localization copy", "i18n copy", product/site/app strings, release feed copy, runtime catalog, or a user asks whether localized copy feels native.
|
|
92
|
+
|
|
93
|
+
Load `references/write-product-localization.md`. If Chinese is one of the locales, also load `references/write-zh-bilingual.md`.
|
|
94
|
+
|
|
95
|
+
Default workflow:
|
|
96
|
+
|
|
97
|
+
1. Separate surfaces first: release feed, website pages, docs/help, runtime strings, legal/privacy copy, and generated pages may have different locale coverage and source files.
|
|
98
|
+
2. Preserve factual structure: versions, dates, links, item order, placeholders, and product behavior remain fixed unless the user asks to change them.
|
|
99
|
+
3. Review by locale artifacts, not by English meaning alone. Missing accents, ASCII fallbacks, literal possessives, stale locale paths, and mechanical plural or apostrophe errors are first-class issues.
|
|
100
|
+
4. After broad cleanup, run a second pass for replacement damage. Do not trust accent sweeps or glossary replacements until the generated output has been checked.
|
|
101
|
+
5. When asked to implement, patch the source localization files and rebuild generated pages. When asked only to review, return findings grouped by surface and severity.
|
|
102
|
+
|
|
103
|
+
## Release Note Template Mode
|
|
104
|
+
|
|
105
|
+
Activate when: "release", "changelog", "version", "release notes"
|
|
106
|
+
|
|
107
|
+
Generate from commit messages:
|
|
108
|
+
- **Breaking Changes**
|
|
109
|
+
- **New Features**
|
|
110
|
+
- **Fixes & Improvements**
|
|
111
|
+
- **Deprecations**
|
|
112
|
+
|
|
113
|
+
Format: target-project style by default. If no project style is available, use numbered items with bold labels, one sentence on user effect, and bilingual output only when the project already uses bilingual release notes.
|
|
114
|
+
|
|
115
|
+
### Release Notes Pre-flight
|
|
116
|
+
|
|
117
|
+
Before drafting, gather style references:
|
|
118
|
+
|
|
119
|
+
1. Read the target project's `CLAUDE.md` for its Release Convention / Release Flow section.
|
|
120
|
+
2. Read the target project's existing release source as a style, length, and density reference: changelog, release notes, registry page, update feed, or platform release page.
|
|
121
|
+
3. For GitHub projects, `gh release view --json body -R <owner>/<repo>` is the preferred way to read the most recent release when `gh` is available. If the project is not on GitHub, use the release source named by the project docs or user request.
|
|
122
|
+
4. If the user mentions comparing with a sibling project's release style, ask for the target identifier or release URL before fetching it.
|
|
123
|
+
5. Match the reference release's item count, sentence length, and tone. Do not invent a new format.
|
|
124
|
+
6. Keep each release-note item to one sentence unless the reference project clearly does otherwise. Do not add emoji to release prose unless the target surface is explicitly a reaction or celebratory social surface.
|
|
125
|
+
|
|
126
|
+
### Release Notes Content Rules
|
|
127
|
+
|
|
128
|
+
- **Group by user-perceivable feature**, not by internal taxonomy. "Polish", "细节打磨", "Misc improvements", "Chores" are not categories users can act on. Group by product surface (Clean / Uninstall / Status / Settings) or by user-visible verb (Faster startup / New keyboard shortcut / Fixed crash on M3).
|
|
129
|
+
- **Extract from `git log <last-tag>..HEAD`** rather than from memory. Read every `feat:` and `fix:` commit; do not omit small items just because they look minor in commit form (iOS wrapper support, Dock cleanup, AV-vendor protection boundary are not "minor" from a user point of view).
|
|
130
|
+
- **One sentence per item, naming the user-visible change**, not the implementation. "Use `CKDownloadQueue` observer for App Store updates" is not a release note; "App Store updates now run inside the app instead of opening App Store" is.
|
|
131
|
+
- **Bilingual structure**: when the project ships bilingual release notes, put the English block and the Chinese block as two parallel sections inside the same release item; do not interleave per bullet. For HTML-capable update-feed CDATA, separate language blocks with headings so the rendered update window does not collapse them together.
|
|
132
|
+
- **No em-dash** in release prose (covered by the Hard Rule). Use Chinese full-width punctuation in Chinese blocks, ASCII in English blocks.
|
|
133
|
+
|
|
134
|
+
## Public Reply Mode (GitHub issue / PR)
|
|
135
|
+
|
|
136
|
+
Activate when: "回复 issue", "reply to PR", "comment on #N", "回 issue", or the user asks for the text of a GitHub issue / PR comment.
|
|
137
|
+
|
|
138
|
+
Five hard rules for the reply body:
|
|
139
|
+
|
|
140
|
+
1. **Open with `@<reporter>` + one thanks line.** Match the reporter's language (Chinese → "感谢反馈" / English → "thanks for the detailed report"). No exclamation mark. No emoji. No "🙏".
|
|
141
|
+
2. **Then state the cause in one sentence, the impact in one sentence.** No multi-paragraph background, no internal symbol names, no walk-through of the fix.
|
|
142
|
+
3. **Then state the ship state**, exactly one of: already shipped in v<X.Y.Z>, fixed on `main` and going out in the next release, planned for v<X.Y.Z>, not planned (with one-line reason and an alternative path). Do not write "already shipped" without release evidence in the current turn.
|
|
143
|
+
4. **Two paragraphs maximum**, separated by one blank line. No bullet lists, no section headers, no code blocks except a one-line command when actually needed.
|
|
144
|
+
5. **No em-dash.** Use commas, periods, colons. (Covered by the Hard Rule, surfaced again because issue replies attract this pattern.)
|
|
145
|
+
|
|
146
|
+
The reply is the final user-facing text, not an agent log. Do not write "刚才我判断错了", "前面回复有误", "I re-read it and changed the comment", or any meta narration about your own process. If editing an existing maintainer comment, replace it with the clean final wording as if it were the only comment the user will read.
|
|
147
|
+
|
|
148
|
+
Before posting, re-read the live issue / PR with `gh issue view <num>` or `gh pr view <num>`. Do not reply from memory; titles, states, and author languages change between sessions.
|
|
149
|
+
|
|
150
|
+
For paid / subscribed users, acknowledge the purchase relationship and the inconvenience in one phrase, then state the boundary. Do not over-explain. When the current product cannot support their setup, suggest the safest practical path (upgrade macOS, wait for the next release, provide logs, refund route) without arguing.
|
|
151
|
+
|
|
152
|
+
Closing rule: when closing as `completed`, the comment must independently explain what was fixed and the expected release. When closing as `not planned`, the comment must independently explain the current boundary and an alternative path. Do not rely on prior thread context as the explanation.
|
|
153
|
+
|
|
154
|
+
## Document Review Mode
|
|
155
|
+
|
|
156
|
+
Activate when: PDF, document, white paper, "review this document", "check this document", "审稿"
|
|
157
|
+
|
|
158
|
+
Review checklist:
|
|
159
|
+
- **Privacy scan**: Detect PII (names, companies, employment dates, salary hints, location details). Hard stop if any text implies job seeking, competitor info, or personal data leakage.
|
|
160
|
+
- **Tone consistency**: Flag voice shifts, register mismatches, formulaic phrasing. Check for AI patterns using the loaded `write-zh.md` or `write-en.md` rules.
|
|
161
|
+
- **Bilingual validation**: For CN/EN pairs, confirm translation accuracy and terminology consistency. Apply Bilingual Review Mode rules.
|
|
162
|
+
- **Rendering check**: Placeholder text remaining (`Lorem ipsum`, `TODO`, `[TBD]`), broken image links.
|
|
163
|
+
- **Durable-doc scan**: If the document is a review report, scorecard, or diagnostic snapshot, flag dated claims, stale line references, private paths, repo-specific commands, and current-score framing. Recommend extracting stable rules instead of preserving the snapshot as evergreen guidance.
|
|
164
|
+
|
|
165
|
+
Output format: same as prose rewrite, but append `privacy: clear / N issues found` after the reviewed text.
|
|
166
|
+
|
|
167
|
+
## Paragraph Coherence Mode
|
|
168
|
+
|
|
169
|
+
Activate when: "连贯性", "段落连贯", "可读性", "coherence", "flow check", "段落顺不顺"
|
|
170
|
+
|
|
171
|
+
Do not rewrite. Instead, work through each paragraph in sequence:
|
|
172
|
+
1. Flag transitions that abruptly shift topic without a signal.
|
|
173
|
+
2. Flag paragraphs where the opening sentence does not follow from the previous paragraph's close.
|
|
174
|
+
3. Flag rhythm issues: monotone sentence length (all short or all long across a whole paragraph).
|
|
175
|
+
4. Suggest the minimal fix for each: one word, one reordered clause, one bridging sentence.
|
|
176
|
+
|
|
177
|
+
Output: a numbered list of issues, each with the paragraph location and a one-line fix suggestion. Then ask if the user wants any applied.
|
|
178
|
+
|
|
179
|
+
## Tweet / Social Post Mode
|
|
180
|
+
|
|
181
|
+
Activate when: "推特", "twitter", "X推文", "tweet", "social post", "折叠长度", "长文推特", "发文"
|
|
182
|
+
|
|
183
|
+
Apply the five announcement rules for product-engineer projects when the project context or prior artifact shows this style:
|
|
184
|
+
1. **Lead with community**: open with the social anchor (star count, user thanks, whose feedback drove the fix). Changes follow, not lead.
|
|
185
|
+
2. **Highlights over completeness**: pick 2 to 4 of the most interesting changes. Dropping whole items is fine.
|
|
186
|
+
3. **UX framing**: phrase each point as "你用它的时候..." or "有一种...的感觉", not "这个工具做了...".
|
|
187
|
+
4. **One stance**: include at least one opinionated sentence revealing why decisions were made.
|
|
188
|
+
5. **Native Chinese rhythm**: use idiomatic phrasing. Avoid translation-sounding terms.
|
|
189
|
+
|
|
190
|
+
Close casually with an invitation, not a CTA. End with one short sentence inviting readers to try, not "立即升级".
|
|
191
|
+
|
|
192
|
+
For other engineering projects or English posts, apply the same structure (community lead, highlights, UX framing, one stance, casual close) adapted to the project's voice.
|
|
193
|
+
|
|
194
|
+
## Gotchas
|
|
195
|
+
|
|
196
|
+
| What happened | Rule |
|
|
197
|
+
|---------------|------|
|
|
198
|
+
| Reorganized headings without being asked | Do not restructure; edit in place unless structure changes are explicitly requested |
|
|
199
|
+
| Appended a "changes made" list after the rewrite | Output is the edited text only. No changelog, no commentary. |
|
|
200
|
+
| Used formal register for a blog draft | Match the target audience's register. Blog is conversational, not academic. |
|
|
201
|
+
| Applied Chinese/English spacing rules to a pure-English text | Bilingual spacing rules (半角/全角) only apply when the text mixes Chinese and English |
|
|
202
|
+
| Polished the user's voice into generic launch copy | Preserve the author's cadence and stance. Use real product artifacts to sharpen facts, not to replace the voice. |
|
|
203
|
+
| Drafted release or social copy from memory or a handoff | Read the current release page, changelog, issue/PR, runnable artifact, product page, screenshot, or supplied source before making factual claims. |
|
|
204
|
+
| Wrote launch copy in one pass without checking the live screenshots | Iterate: draft, compare against the real product screenshot or page, tighten wording to match what ships, repeat until copy and artifact agree |
|
|
205
|
+
| Polished a review report until it sounded timeless | Keep snapshots labeled as snapshots, or distill them into stable rules. Do not make dated claims sound evergreen |
|
|
206
|
+
|
|
207
|
+
## Output
|
|
208
|
+
|
|
209
|
+
Return only the edited prose. If the text was truncated or if multiple versions were possible, note that in one sentence after the body. Otherwise, no wrapper, no preamble, no postscript.
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
> **How to use this file**: it is a catalog of smells, not a checklist to run top to bottom. The principles in `SKILL.md` Core Stance apply here too: over-editing is failure, the author's voice and genre win, and these lists are examples, not find-and-replace. A sentence that already reads natural stays. Match the smell, not the word.
|
|
2
|
+
|
|
3
|
+
## English Scenario
|
|
4
|
+
|
|
5
|
+
Eliminate predictable AI writing patterns. Write like a human: varied, imperfect, specific.
|
|
6
|
+
|
|
7
|
+
### Core Rules
|
|
8
|
+
|
|
9
|
+
1. **Cut filler phrases.** Remove throat-clearing openers, emphasis crutches, and adverbs that only signal emphasis. Keep adverbs that carry real meaning.
|
|
10
|
+
2. **Break formulaic structures.** Avoid binary contrasts, negative listings, dramatic fragmentation, rhetorical setups, false agency.
|
|
11
|
+
3. **Use active voice.** Every sentence needs a human subject doing something. No inanimate objects performing human actions ("the complaint becomes a fix").
|
|
12
|
+
4. **Be specific.** No vague declaratives ("The reasons are structural"). Name the specific thing. No lazy extremes ("every," "always," "never") doing vague work.
|
|
13
|
+
5. **Put the reader in the room.** No narrator-from-a-distance voice. "You" beats "People." Specifics beat abstractions.
|
|
14
|
+
6. **Vary rhythm.** Mix sentence lengths. Two items beat three. End paragraphs differently. No em dashes.
|
|
15
|
+
7. **Trust readers.** State facts directly. Skip softening, justification, hand-holding.
|
|
16
|
+
8. **Cut quotables.** If it sounds like a pull-quote, rewrite it.
|
|
17
|
+
9. **Do not replace one formula with another.** “Human” does not mean slangy, quirky, or performatively casual.
|
|
18
|
+
10. **No emoji.** Remove any emoji from the text being edited.
|
|
19
|
+
|
|
20
|
+
### Word Choice
|
|
21
|
+
|
|
22
|
+
Examples, not exhaustive -- any word used to signal importance rather than to say something is suspect.
|
|
23
|
+
|
|
24
|
+
**Overused emphasis adverbs (cut these when they only signal importance, not every adverb):**
|
|
25
|
+
"quietly", "deeply", "fundamentally", "remarkably", "arguably", "certainly", "really", "just", "literally", "genuinely", "honestly", "simply", "actually"
|
|
26
|
+
|
|
27
|
+
> NO: "quietly orchestrating workflows" / "fundamentally reshape how we think"
|
|
28
|
+
> OK: Say what it does. Drop the adverb.
|
|
29
|
+
|
|
30
|
+
**AI vocabulary: replace with plain language:**
|
|
31
|
+
|
|
32
|
+
| Avoid | Use instead |
|
|
33
|
+
|-------|-------------|
|
|
34
|
+
| delve (into) | examine, look at, explore |
|
|
35
|
+
| leverage (as verb) | use |
|
|
36
|
+
| utilize | use |
|
|
37
|
+
| robust | strong, reliable, solid |
|
|
38
|
+
| streamline | simplify, cut |
|
|
39
|
+
| harness | use, apply |
|
|
40
|
+
| navigate (challenges) | handle, address |
|
|
41
|
+
| unpack | explain, examine |
|
|
42
|
+
| paradigm | system, approach, model |
|
|
43
|
+
| synergy | combination, cooperation |
|
|
44
|
+
| ecosystem | community, network, field |
|
|
45
|
+
| tapestry | mix, combination |
|
|
46
|
+
| landscape | situation, field, area |
|
|
47
|
+
| game-changer | significant, important |
|
|
48
|
+
| deep dive | analysis, examination |
|
|
49
|
+
| moving forward | next, from now |
|
|
50
|
+
|
|
51
|
+
**Pompous copulas: use "is" instead:**
|
|
52
|
+
> NO: "serves as", "stands as", "marks", "represents"
|
|
53
|
+
> OK: "is"
|
|
54
|
+
|
|
55
|
+
### Sentence Structures to Avoid
|
|
56
|
+
|
|
57
|
+
Examples, not exhaustive -- any construction that performs insight rather than delivers it belongs here.
|
|
58
|
+
|
|
59
|
+
**Negative parallelism**: the single most common AI tell:
|
|
60
|
+
> NO: "It's not bold. It's backwards." / "Not because X, but because Y." / "The question isn't X. The question is Y."
|
|
61
|
+
> OK: State Y directly. Drop the negation entirely.
|
|
62
|
+
|
|
63
|
+
**Negative countdown:**
|
|
64
|
+
> NO: "Not a bug. Not a feature. A fundamental design flaw."
|
|
65
|
+
> OK: "It's a fundamental design flaw."
|
|
66
|
+
|
|
67
|
+
**Rhetorical self-questions:**
|
|
68
|
+
> NO: "The result? Devastating." / "The worst part? Nobody saw it coming."
|
|
69
|
+
> OK: State it: "The result was devastating."
|
|
70
|
+
|
|
71
|
+
**Anaphora abuse**: repeating the same sentence opener:
|
|
72
|
+
> NO: "They assume that... They assume that... They assume that..."
|
|
73
|
+
> OK: Combine or restructure. One statement, clear subject.
|
|
74
|
+
|
|
75
|
+
**Tricolon abuse**: rule of three, used three times back to back:
|
|
76
|
+
> NO: "Products impress people; platforms empower them. Products solve problems; platforms create worlds."
|
|
77
|
+
> OK: Make the point once, cleanly.
|
|
78
|
+
|
|
79
|
+
**False ranges:**
|
|
80
|
+
> NO: "From innovation to cultural transformation" (what's in between?)
|
|
81
|
+
> OK: List the two things directly, or pick one.
|
|
82
|
+
|
|
83
|
+
**Dramatic fragmentation**: manufactured emphasis via fragments:
|
|
84
|
+
> NO: "He published this. Openly. In a book. As a priest."
|
|
85
|
+
> OK: Complete sentences. Trust content over presentation.
|
|
86
|
+
|
|
87
|
+
**False agency**: inanimate objects performing human verbs:
|
|
88
|
+
> NO: "the complaint becomes a fix" / "the decision emerges" / "the data tells us"
|
|
89
|
+
> OK: Name the human. "Someone fixed it." "The team decided."
|
|
90
|
+
|
|
91
|
+
### Tone Patterns to Avoid
|
|
92
|
+
|
|
93
|
+
**False suspense transitions:**
|
|
94
|
+
> NO: "Here's the kicker." / "Here's the thing." / "Here's where it gets interesting."
|
|
95
|
+
> OK: Make the point. No buildup.
|
|
96
|
+
|
|
97
|
+
**Patronizing analogies:**
|
|
98
|
+
> NO: "Think of it like a highway system for data." / "Think of it as a Swiss Army knife."
|
|
99
|
+
> OK: Explain the concept directly. If an analogy helps, test it against three criteria before keeping it: (1) remove it and the paragraph collapses: it is load-bearing, not decorative; (2) push it one layer deeper and it still holds; (3) the reader gets it without further explanation. If it fails any of these, drop the analogy and state the idea directly.
|
|
100
|
+
|
|
101
|
+
**Futurist invitation:**
|
|
102
|
+
> NO: "Imagine a world where every tool you use has a quiet intelligence behind it..."
|
|
103
|
+
> OK: Describe what actually exists or what you're actually proposing.
|
|
104
|
+
|
|
105
|
+
**False vulnerability**: performative self-awareness:
|
|
106
|
+
> NO: "And yes, I'm openly in love with the platform model"
|
|
107
|
+
> OK: Real vulnerability is specific and uncomfortable. Skip the polish.
|
|
108
|
+
|
|
109
|
+
**Asserting simplicity instead of proving it:**
|
|
110
|
+
> NO: "The reality is simpler and less flattering" / "History is clear"
|
|
111
|
+
> OK: Show the evidence. Don't announce the conclusion before it.
|
|
112
|
+
|
|
113
|
+
**Grandiose stakes inflation:**
|
|
114
|
+
> NO: "This will fundamentally reshape how we think about everything." / "will define the next era of computing"
|
|
115
|
+
> OK: Say what it actually does.
|
|
116
|
+
|
|
117
|
+
**Pedagogical hand-holding:**
|
|
118
|
+
> NO: "Let's break this down step by step." / "Let's unpack what this really means."
|
|
119
|
+
> OK: Start with the content, not an announcement of the content.
|
|
120
|
+
|
|
121
|
+
**Vague attributions:**
|
|
122
|
+
> NO: "Experts argue..." / "Industry reports suggest..." / "Observers have cited..."
|
|
123
|
+
> OK: Name the expert, link the report, quote the person. If you can't, you don't have a source.
|
|
124
|
+
|
|
125
|
+
**Invented concept labels**: compound labels that sound analytical but aren't grounded:
|
|
126
|
+
> NO: "the supervision paradox" / "the acceleration trap" / "workload creep"
|
|
127
|
+
> OK: Describe the thing directly. Don't name it as if it's an established term.
|
|
128
|
+
|
|
129
|
+
### Paragraph & Composition Patterns to Avoid
|
|
130
|
+
|
|
131
|
+
**Short punchy fragments as paragraphs:**
|
|
132
|
+
> NO: "These weren't just products. And the software side matched. Then it professionalised."
|
|
133
|
+
> OK: Complete sentences. No staccato drama.
|
|
134
|
+
|
|
135
|
+
**Bold-first bullets**: every bullet starts with a bolded phrase:
|
|
136
|
+
> NO: "**Security**: Environment-based configuration..." / "**Performance**: Lazy loading..."
|
|
137
|
+
> OK: Write bullets as sentences, or drop the bold. Not every list needs labels.
|
|
138
|
+
|
|
139
|
+
**Fractal summaries**: "what I'm going to tell you; what I'm telling you; what I just told you":
|
|
140
|
+
> NO: "In this section, we'll explore... [3000 words later] ...as we've seen in this section."
|
|
141
|
+
> OK: Skip the preview and the recap. Write the content.
|
|
142
|
+
> Exception: a single closing sentence in a TL;DR that orients non-specialist readers to the structure ahead ("The rest of this piece follows X in order...") is intentional navigation, not a fractal summary. Keep it; flag it at most, but do not delete without author approval.
|
|
143
|
+
|
|
144
|
+
**Signposted conclusions:**
|
|
145
|
+
> NO: "In conclusion..." / "To sum up..." / "In summary..."
|
|
146
|
+
> OK: End. Don't announce that you're ending.
|
|
147
|
+
|
|
148
|
+
**The dead metaphor**: one metaphor used 10 times across a piece:
|
|
149
|
+
> NO: "The ecosystem needs ecosystems to build ecosystem value."
|
|
150
|
+
> OK: Use a metaphor once, then move on.
|
|
151
|
+
|
|
152
|
+
**Historical analogy stacking:**
|
|
153
|
+
> NO: "Apple didn't build Uber. Facebook didn't build Spotify. Stripe didn't build Shopify."
|
|
154
|
+
> OK: Make the point. One example is enough.
|
|
155
|
+
|
|
156
|
+
**One-point dilution**: same argument restated 10 ways across 4000 words:
|
|
157
|
+
> OK: Say it once. Add evidence or move on.
|
|
158
|
+
|
|
159
|
+
**"Despite its challenges..." formula:**
|
|
160
|
+
> NO: "Despite these challenges, the initiative continues to thrive."
|
|
161
|
+
> OK: Either address the challenges or don't raise them.
|
|
162
|
+
|
|
163
|
+
**It's worth noting / It bears mentioning:**
|
|
164
|
+
> NO: "It's worth noting that this approach has limitations." / "Notably," / "Importantly,"
|
|
165
|
+
> OK: Say the thing directly. Skip the announcement.
|
|
166
|
+
|
|
167
|
+
**Meta figure and diagram explanations:**
|
|
168
|
+
> NO: "This diagram lists the sensor stack of a humanoid robot. With it in view, the previous problems become easier to place."
|
|
169
|
+
> NO: "I made this diagram with ChatGPT Image2. Seeing the representations side by side makes the differences easier to grasp."
|
|
170
|
+
> NO: "This timeline shows the evolution... That is one of the reasons I find this field more interesting..."
|
|
171
|
+
> OK: The image or timeline itself. Let the surrounding judgment or personal project anchor carry the weight. Keep creation-process details only if they are themselves part of the story.
|
|
172
|
+
|
|
173
|
+
**List or classification intros:**
|
|
174
|
+
> NO: "Community data is an interesting piece. Diversity has to cover..."
|
|
175
|
+
> NO: "One detail is easy to miss. 'Output action' can mean..."
|
|
176
|
+
> OK: Go straight to the content: "Community data has a practical requirement: diversity has to cover..." or "Output action can mean different things..."
|
|
177
|
+
|
|
178
|
+
**Re-anchoring after cutting recaps (long-form articles):**
|
|
179
|
+
After removing table re-reads and structural repetition, scan the remaining prose for places where a general explanation can be tied back to the author's concrete project or experience already mentioned in the piece. This is one of the strongest ways to restore human voice in technical long-form writing.
|
|
180
|
+
|
|
181
|
+
### Quick Checks Before Delivering Prose
|
|
182
|
+
|
|
183
|
+
- Any adverb only adding emphasis? Cut it. (Meaning-bearing adverbs stay.)
|
|
184
|
+
- Any passive voice? Find the actor, make them the subject.
|
|
185
|
+
- Inanimate thing doing a human verb? Name the person.
|
|
186
|
+
- Sentence starts with "Here's"? Cut to the point.
|
|
187
|
+
- Any "not X, it's Y" contrasts? State Y directly.
|
|
188
|
+
- Three consecutive sentences match length? Break one.
|
|
189
|
+
- Paragraph ends with punchy one-liner? Vary it.
|
|
190
|
+
- Em-dash anywhere? Remove it.
|
|
191
|
+
- Vague declarative ("The implications are significant")? Name the specific implication.
|
|
192
|
+
- Meta-joiners ("The rest of this essay...")? Delete. Exception: a single TL;DR closing sentence that orients readers to the structure ahead is navigation, not filler. Keep it.
|
|
193
|
+
- Any bullet starting with bold label? Reconsider the format.
|
|
194
|
+
- Any "In conclusion" or "To sum up"? Cut it.
|
|
195
|
+
- Any emoji? Remove it.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
**Bottom line: varied, imperfect, specific. Any single trope used once may be fine. The problem is when multiple appear together or one repeats.**
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Product Localization Copy Review
|
|
2
|
+
|
|
3
|
+
Use this when reviewing product pages, release notes, app strings, runtime notifications, appcast or update feeds, docs/help pages, legal/privacy copy, and other localized product surfaces.
|
|
4
|
+
|
|
5
|
+
## Core Principles
|
|
6
|
+
|
|
7
|
+
1. **Split surfaces before editing.** A release feed, website page, runtime catalog, help article, and legal page may intentionally support different locale sets. Do not force every surface to mirror the broadest one.
|
|
8
|
+
2. **Keep product facts fixed.** Preserve versions, dates, item order, links, placeholders, keyboard shortcuts, product names, bundle IDs, and behavior claims unless the user asked to change them.
|
|
9
|
+
3. **Use source files, not generated output, as the edit target.** Patch generated pages only when the project explicitly treats them as source. Otherwise find the template, locale JSON, string catalog, or content partial and rebuild.
|
|
10
|
+
4. **Review the final rendered or generated surface.** A translation can look fine in a source file but break in a button, menu, release feed, notification, or generated HTML page.
|
|
11
|
+
5. **Do not polish into generic marketing.** Native localization means the sentence sounds like a local product, not like a fluent sales page.
|
|
12
|
+
|
|
13
|
+
## High-Signal Failure Patterns
|
|
14
|
+
|
|
15
|
+
- **Chinese**: Literal possessives such as "你的 Mac" or "你的设备" when plain "Mac" or "本机" is enough; machine-output verbs such as "检测到" when a result sentence would read better; mixed punctuation; English words with stable Chinese equivalents.
|
|
16
|
+
- **Traditional Chinese**: Mainland phrasing copied into Traditional copy; stale locale URLs; words that feel mainland-specific or overly colloquial for the target audience.
|
|
17
|
+
- **Japanese**: English noun compounds translated too tightly; missing spaces around product terms when the project style uses them; UI strings that sound like a manual instead of a Mac app.
|
|
18
|
+
- **Korean**: Inconsistent platform terms, especially menu bar / menu item wording; overly literal second-person sentences.
|
|
19
|
+
- **German**: ASCII fallbacks such as `fuer`, `Pruef`, `Eintraege`, `Menue`, `Luefter`; English developer nouns like "binary" in user-facing copy.
|
|
20
|
+
- **Spanish**: Missing accents such as `gestion`, `analisis`, `menus`, `suscripcion`; mechanical replacements that create invalid forms like `actualizaciónes`.
|
|
21
|
+
- **French**: Missing apostrophes or accents such as `L app`, `memoire`, `desinstallation`, `defaut`; spaces before punctuation should follow French conventions when the surrounding text already does.
|
|
22
|
+
- **Italian**: Missing accents and articles such as `piu`, `non e`, `un app`; mechanical replacements that create invalid forms like `puòi`.
|
|
23
|
+
|
|
24
|
+
## Review Procedure
|
|
25
|
+
|
|
26
|
+
1. Identify all source and generated surfaces in scope. For websites, include templates, locale JSON, content partials, generated pages, language switchers, canonical links, and route rewrites. For apps, include runtime catalogs, permission strings, update feeds, and notification copy.
|
|
27
|
+
2. Pick the factual source of truth. Release notes usually follow the English release page or changelog; runtime copy follows the current app behavior and placeholders.
|
|
28
|
+
3. Run a first pass for local voice: remove translationese, restore local punctuation, and keep product names stable.
|
|
29
|
+
4. Run a second pass for mechanical artifacts: missing accents, stale paths, invalid plural forms, malformed placeholders, and accidental path translations.
|
|
30
|
+
5. Rebuild generated files and rerun the relevant project checks. If the user only asked for review, list the required checks instead of claiming they ran.
|
|
31
|
+
|
|
32
|
+
## Rewrite Rules
|
|
33
|
+
|
|
34
|
+
- Keep placeholders exactly, including order and type: `%@`, `%d`, `%1$@`, `{name}`, and similar tokens.
|
|
35
|
+
- Do not glue translated fragments with punctuation in code or copy. A full sentence or format string per locale is safer.
|
|
36
|
+
- Avoid broad find-and-replace unless it is followed by residual scans. Broad accent fixes can produce broken words.
|
|
37
|
+
- Leave product names and established UI names in English when the product itself uses them that way.
|
|
38
|
+
- Legal and privacy copy should be plain and accurate. Do not make it friendlier by weakening obligations, data collection boundaries, refund terms, or third-party roles.
|
|
39
|
+
- Release feed localization can be narrower than website localization. Respect the surface-specific product decision.
|
|
40
|
+
|
|
41
|
+
## Output Guidance
|
|
42
|
+
|
|
43
|
+
For rewrite requests, return the edited localized copy. For review requests, group findings by surface first, then locale. Call out blockers where copy misstates product behavior, privacy, legal terms, version history, or update availability.
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# 中英双语规则
|
|
2
|
+
|
|
3
|
+
## 双语一致性检查
|
|
4
|
+
|
|
5
|
+
**中英混排格式**(来自 mzlogin/chinese-copywriting-guidelines):
|
|
6
|
+
- 中文和英文字符之间加空格:`CN文字EN` → `CN 文字 EN`
|
|
7
|
+
- 不混用标点:中文用 `、。?!;:`,不用英文逗号/句号
|
|
8
|
+
- 术语跨全文一致
|
|
9
|
+
|
|
10
|
+
**中文里的英文**:标记出现的未翻译英文,建议翻译或加说明。
|
|
11
|
+
|
|
12
|
+
**双语对**:确认 EN 和 CN 版本传达的意思相同;标记翻译损失。
|
|
13
|
+
|
|
14
|
+
## 英文术语首次出现规则
|
|
15
|
+
|
|
16
|
+
- 首次出现:保留英文 + 中文注解,或中文前置 + 英文括注(`指令微调(Instruction tuning)`)
|
|
17
|
+
- 后续出现:只用中文,不要英中混用
|
|
18
|
+
- 例外:SFT、RL、MoE 这类已成行业通用缩写,全程保留缩写形式
|
|
19
|
+
|
|
20
|
+
## 有稳定中文对译的英文词
|
|
21
|
+
|
|
22
|
+
中文技术圈已有通用译法的,换中文:
|
|
23
|
+
|
|
24
|
+
| 英文 | 推荐中文 |
|
|
25
|
+
|------|----------|
|
|
26
|
+
| context | 上下文 |
|
|
27
|
+
| state | 状态 |
|
|
28
|
+
| cache | 缓存 |
|
|
29
|
+
| claim | 断言 |
|
|
30
|
+
| runtime | 运行时 |
|
|
31
|
+
| contract | 契约 |
|
|
32
|
+
|
|
33
|
+
术语在中文圈还未收敛的(prompt、embedding、tokenizer),保留英文合理。
|
|
34
|
+
|
|
35
|
+
## 翻译腔套路(主动排查)
|
|
36
|
+
|
|
37
|
+
**物理动作动词**:接住、击穿、锋利、不崩、不爆、打穿、扛住,这类词把抽象认知过程想象成了物理动作(骨架是英文 catch/pierce/sharp)。换成日常中文:你这几条我都收到了 / 这个假设不成立。
|
|
38
|
+
|
|
39
|
+
**形容词预判+冒号**:"更干净:"、"逻辑很清晰:"引出内容。删掉形容词,只留后面事实。
|
|
40
|
+
|
|
41
|
+
**抽象名词做主语**:"工程上的现实比这些数字难看"这种骨架,凡碰到"X 的 Y 比 Z 更 W",重写让人/动作做主语。
|
|
42
|
+
|
|
43
|
+
**有稳定对译词直接混入**:"context 不崩、state 可恢复",换成中文。
|
|
44
|
+
|
|
45
|
+
## 双语并列的排版
|
|
46
|
+
|
|
47
|
+
中英双语 release notes 的排版:
|
|
48
|
+
|
|
49
|
+
- 英文版在前,中文版在后(或分两个段落)
|
|
50
|
+
- 条目编号一一对应
|
|
51
|
+
- 专有名词(产品名、功能名)在两种语言里保持一致
|
|
52
|
+
- 不要在同一条内中英混写
|
|
53
|
+
|
|
54
|
+
## 标点规则
|
|
55
|
+
|
|
56
|
+
- 中文标点:`,。;:!?、""『』【】`
|
|
57
|
+
- 英文在中文句子中出现时用中文标点断句
|
|
58
|
+
- 禁止用破折号(—),用逗号或分号替代
|
|
59
|
+
- `bold 小标题 + 句号` 改为 `bold 小标题 + 逗号`(内联而非独立标题)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# 中文散文核心规则
|
|
2
|
+
|
|
3
|
+
技术长文的去 AI 味和自然化。完整规则见 `write-zh.md`,本文摘录最高频的 10 类改写模式。
|
|
4
|
+
|
|
5
|
+
## 最高优先级:保语义 > 去 AI 味
|
|
6
|
+
|
|
7
|
+
先确认事实、逻辑、因果不变,再做以下改写。如果为"更口语"改坏原意,属于失败改写。
|
|
8
|
+
|
|
9
|
+
## 高频 AI 痕迹(首先检查)
|
|
10
|
+
|
|
11
|
+
**1. 段末收尾总结句**:一段刚解释完某机制,结尾再重述一遍。识别信号:"到这里"、"这说明"、"这本身就是"、"可以看出"开头,或者段落最后一句比其他句短且抽象。直接删掉。
|
|
12
|
+
|
|
13
|
+
**2. 升华句**:把具体工程观察上升到普适人生道理。直接给出具体建议,不升华。
|
|
14
|
+
|
|
15
|
+
**3. 对比句式**:"不是…而是…"、"X 本身没有价值,真正有用的是 Y"、"X 已经不是瓶颈,Y 才是"。直接说结论,不用对比框架铺垫。
|
|
16
|
+
|
|
17
|
+
**4. bold 小标题模式**:`**xxx**。content` 改为 `**xxx**,content`,让 bold 变成承重词,不是独立小标题。例外:bold 部分本身是完整句子时保留句号。
|
|
18
|
+
|
|
19
|
+
**5. 章节引介过渡句**:章节开头或结尾写"上面这些模式解决的是…,下面再看…"。直接删掉,章节标题本身已经承接。
|
|
20
|
+
|
|
21
|
+
**6. 空泛形容词预判**:"更干净:"、"逻辑很清晰:",形容词抢先下判断。删掉形容词,只留后面的事实。
|
|
22
|
+
|
|
23
|
+
**7. 工整并列 bold 标题**:四个 bold 标题全是同一格式。每个点语气不同,或改成散文叙述。
|
|
24
|
+
|
|
25
|
+
**8. 段内重复**:同一段把同一意思用不同措辞说两遍。说一遍,够了。
|
|
26
|
+
|
|
27
|
+
**9. 讲解腔起手**:"真拆开看"、"这背后是同一个变化"、"真正关键的问题是"。删掉,直接说。
|
|
28
|
+
|
|
29
|
+
**10. 训人感起手**:"先问问是不是"、"你要先明白"。改成"可以先看"、"先确认"。
|
|
30
|
+
|
|
31
|
+
## 句式规则
|
|
32
|
+
|
|
33
|
+
- 禁止用破折号(—),用逗号或分号代替
|
|
34
|
+
- 四五个句号连发、每句很短 = 打电报,合成长句或用逗号连
|
|
35
|
+
- 单独成段的一两句话,多半是上一段的收尾,直接并进去
|
|
36
|
+
- 不用"首先…其次…最后",用"一方面…另一方面…"
|
|
37
|
+
|
|
38
|
+
## 用词去正式化
|
|
39
|
+
|
|
40
|
+
| 不用 | 用 |
|
|
41
|
+
|------|-----|
|
|
42
|
+
| 非常/极其 | 很 |
|
|
43
|
+
| 综上所述 | 直接收尾 |
|
|
44
|
+
| 例如 | 比如 |
|
|
45
|
+
| 购买/使用 | 买/用 |
|
|
46
|
+
| 值得注意的是 | 直接说结论 |
|
|
47
|
+
|
|
48
|
+
完整规则、AI 味检测所有模式、标题设计、引号/括号/分号规则见 `write-zh.md`。
|
|
49
|
+
|
|
50
|
+
长文(多 `##` 节、带表格和图)先做结构再抠句子:跨章节同义清单只留最全一份、表格旁正文别复读、判断/取舍类列表默认转 prose,详见 `write-zh.md` 的「结构级重复与表格复读(长文专项)」,整体流程见 `SKILL.md` 的 Long-form Article Mode。
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# 对外发文专项:release notes 和推文
|
|
2
|
+
|
|
3
|
+
## 推文 / 社交发文五规则
|
|
4
|
+
|
|
5
|
+
适用于已有社区语气和轻量发布节奏的产品工程师项目对外发文:
|
|
6
|
+
|
|
7
|
+
1. **社区先行**:开头用社会锚点(star 数、感谢用户、谁的反馈推动了这次修复)。改动清单跟在后面,不放在最前。
|
|
8
|
+
2. **亮点不全量**:挑 2 到 4 个最有意思的改动。跳过整个模块也没问题。读者要的是故事,不是 changelog。
|
|
9
|
+
3. **用户感受帧**:每条写法用"你用它的时候…"或"有一种…的感觉",不是"这个工具做了…"。
|
|
10
|
+
4. **一条立场**:至少一句表明决策原因的意见句(例:"我更相信模型本身的能力,而非各种规则限制他的天花板")。
|
|
11
|
+
5. **中文节奏**:用地道表达(给留了一手、玩玩、大伙、大概就是这些)。避免翻译腔和正式词(具体判据、主轴、本意)。
|
|
12
|
+
|
|
13
|
+
结尾用邀请,不用 CTA:「假如没有用过的小伙伴,欢迎去试试看,玩玩。」而不是「立即升级」。
|
|
14
|
+
|
|
15
|
+
## Release Notes 格式
|
|
16
|
+
|
|
17
|
+
**结构**:Breaking Changes → New Features → Fixes & Improvements → Deprecations
|
|
18
|
+
|
|
19
|
+
**格式**:优先匹配目标项目最近一次 release。没有可用参考时,使用编号列表、bold 标签、一句话说用户效果;只有目标项目已经使用中英双语时才输出双语。
|
|
20
|
+
|
|
21
|
+
**长度参考**:和上一个版本 release 的条目数、句子长度、密度匹配。不要自创新格式。
|
|
22
|
+
|
|
23
|
+
**边界**:GitHub Release 正文和社交公告是两份 artifact。Release notes 解释用户会感受到什么,默认不写 CI、tap、registry、API 名称、fallback 路径等机制细节;公告另按社交发文规则挑 2 到 4 个亮点。
|
|
24
|
+
|
|
25
|
+
## 对外发文专项检查
|
|
26
|
+
|
|
27
|
+
公开发文交出去之前,扫三件事:
|
|
28
|
+
|
|
29
|
+
**1. 身份和敏感信号脱敏**:不出现可反推作者身份的细节(雇主、地点、简历式表述)。技术决策可以具体,身份信息默认删。
|
|
30
|
+
|
|
31
|
+
**2. 不踩竞品**:介绍自己产品时不主动贬低同类产品。直接说自己做了什么、为什么。
|
|
32
|
+
|
|
33
|
+
**3. 用户感受先于功能清单**:先给一句场景或感受,再进改动细节。不要开场就列功能。
|
|
34
|
+
|
|
35
|
+
## 发版前检查
|
|
36
|
+
|
|
37
|
+
- 不出现"不再更新"、"final release"、"停止维护"等终止信号(除非是真实情况)
|
|
38
|
+
- release title 简洁:版本号 + 最核心的改动或主题,不超过 10 个词
|
|
39
|
+
- 中英版本条目数一一对应
|
|
40
|
+
- 建议 5 到 8 条,每条一句话
|