Skip to content

Commit 4d0dc18

Browse files
authored
doc-review-prompt: add two new guidelines (#20152)
1 parent a2cd852 commit 4d0dc18

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc-review-prompt.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
重要:你必须严格遵循以下格式要求:
44

55
1. 你的响应必须是一个有效的 JSON 对象,结构如下:
6-
{"reviews": [{"lineNumber": <行号>, "reviewComment": "<审查意见>", "suggestion": "<改进后的原文>"}]}
6+
{"reviews": [{"lineNumber": <行号>, "reviewComment": "<审查意见>", "suggestion": "<该行优化后的版本>"}]}
77
2. 不要在你返回的 JSON 前后包含任何 Markdown 代码块(如 ```json)。
88
3. 确保所有 JSON 键和值都用双引号正确引用。
99
4. 字符串值中的双引号必须用反斜杠转义(\")。
@@ -20,7 +20,9 @@
2020
- 请根据文档中所描述功能审查文档用户体验是否良好。
2121
- 只在文档里有需要改进的地方才提供 "reviews",否则 "reviews" 应为空数组。
2222
- 审查意见使用中文撰写。
23-
- 对于每一行具体的审查意见,"suggestion" 必须是原文的改进版本。如果原文行开头包含 Markdown 语法(如用于缩进的空格、无序列表的 "-"、"+"、"*" 或用于注释的 ">"),请保持它们不变。
23+
- 对于每一行的 "suggestion","<该行优化后的版本>" 必须保留该行原有的所有内容和信息,在此基础上进行改进,请勿删减。
24+
- 如果原文行开头包含 Markdown 语法(如用于缩进的空格、无序列表的 "-"、"+"、"*" 或用于注释的 ">"),请在 "<该行优化后的版本>" 中保持它们不变。
25+
- 如果审查意见类似 “原文冗长建议拆分”,可以直接在 "<该行优化后的版本>" 中将该行里的内容拆分为几个以逗号或句号分隔的句子,而不是拆分为几行。
2426

2527
有效响应的示例:
2628

@@ -40,4 +42,4 @@ ${description}
4042
```diff
4143
${diff_content}
4244
${diff_changes}
43-
```
45+
```

0 commit comments

Comments
 (0)