Skip to content

Commit 2ce5692

Browse files
RiskeyLclaude
andcommitted
docs: centralize post-writing verification in writing-guides index
Moves the canonical list of post-writing checks into writing-guides/index.md so it lives in one place, adds the two new format-check skills to that list, and shortens the Post-Writing Verification section in each writing skill (guides, api-reference, env-vars) to a one-line pointer. Also unwraps a pre-existing hard-wrapped paragraph in the api-reference skill's Cross-API Links section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 40eceea commit 2ce5692

4 files changed

Lines changed: 17 additions & 14 deletions

File tree

.claude/skills/dify-docs-api-reference/SKILL.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,7 @@ Pattern: `{verb}{AppType}{Resource}`
145145

146146
### Cross-API Links
147147

148-
When a description mentions another endpoint, add a markdown link.
149-
Pattern: `/api-reference/{category}/{endpoint-name}` (kebab-case from endpoint summary).
148+
When a description mentions another endpoint, add a markdown link. Pattern: `/api-reference/{category}/{endpoint-name}` (kebab-case from endpoint summary).
150149

151150
## Parameters
152151

@@ -222,7 +221,4 @@ Exception: Tags without a create operation (e.g., Conversations). GET list comes
222221

223222
## Post-Writing Verification
224223

225-
After completing the document:
226-
227-
1. Invoke `dify-docs-terminology-check` to verify terminology consistency against the glossary and codebase.
228-
2. Invoke `dify-docs-reader-test` to verify it from the reader's perspective.
224+
After completing the document, run the post-writing checks listed in `writing-guides/index.md#post-writing-verification`.

.claude/skills/dify-docs-env-vars/SKILL.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,4 @@ The automated translation pipeline does not cover `en/self-host/configuration/en
143143

144144
## Post-Writing Verification
145145

146-
After completing the document:
147-
148-
1. Invoke `dify-docs-terminology-check` to verify terminology consistency against the glossary and codebase.
149-
2. Invoke `dify-docs-reader-test` to verify it from the reader's perspective.
146+
After completing the document, run the post-writing checks listed in `writing-guides/index.md#post-writing-verification`.

.claude/skills/dify-docs-guides/SKILL.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,4 @@ No overrides. Follow `writing-guides/style-guide.md` as written.
6161

6262
## Post-Writing Verification
6363

64-
After completing the document:
65-
66-
1. Invoke `dify-docs-terminology-check` to verify terminology consistency against the glossary and codebase.
67-
2. Invoke `dify-docs-reader-test` to verify it from the reader's perspective.
64+
After completing the document, run the post-writing checks listed in `writing-guides/index.md#post-writing-verification`.

writing-guides/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ When paths overlap, the most specific match takes precedence.
1515

1616
If no skill matches your task (e.g., fixing a typo, updating navigation), follow the style guide and formatting guide directly.
1717

18+
## Post-Writing Verification
19+
20+
After completing a writing task, run these checks in order. Each is a self-contained skill.
21+
22+
| Step | Skill | Purpose |
23+
|:-----|:------|:--------|
24+
| 1 | dify-docs-format-check-en | Enforce `formatting-guide.md` rules (frontmatter, headings, lists, code, images, spacing) on English content. |
25+
| 2 | dify-docs-format-check-cjk | Enforce general + Chinese/Japanese-specific formatting rules on `zh/` and `ja/` content. Run after translations are generated. |
26+
| 3 | dify-docs-terminology-check | Verify terminology consistency against the glossary and codebase UI labels. |
27+
| 4 | dify-docs-reader-test | Read each page from a first-time reader's perspective and flag comprehension gaps. |
28+
29+
Steps 1 and 3 apply to any English doc change. Step 2 applies after the zh/ja translations are produced. Step 4 is always the last step because it depends on the others passing.
30+
1831
## Reference Files
1932

2033
- **style-guide.md** — Voice, tone, writing patterns, callout usage

0 commit comments

Comments
 (0)