Skip to content

Commit cc17d31

Browse files
committed
fix: revise bullet points
Signed-off-by: Christine <[email protected]>
1 parent 1670476 commit cc17d31

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

website/library/reference/how-to-review-someone's-work.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,16 @@ When it comes to peer reviews, it can get confusing and overwhelming at times be
99
### Content Review
1010

1111
* **Overall structure and flow**:
12-
* Are the steps in the correct order?
13-
* Will the user be able to understand the steps?
14-
* Have all the terms been defined at the first use?
12+
* Are the steps presented in a logical sequence that guides the user effectively?
13+
* Is the language simple for the user to understand?
14+
* Have all the terms been clearly defined?
1515
* **Accuracy and completeness**:
16-
* Are all the steps accurate?
17-
* Are there any steps missing or unclear?
18-
* If you run through the document from start to finish, does it work?
16+
* Does the document present any information that could be unclear or misleading to the user?
17+
* Are all steps accurate and free from mistakes?
18+
* Do the steps' code snippets work when followed?
1919

2020
### Clarity and Readability
2121

22-
* **Wording and clarity**:
23-
* Is everything well worded?
24-
* Are important details missing?
25-
* Can anything be made shorter?
26-
* Does the tone suit the message?
2722
* **Formatting and consistency**:
2823
* Are headings and subheadings used consistently?
2924
* Are lists and tables used effectively?
@@ -43,9 +38,9 @@ When it comes to peer reviews, it can get confusing and overwhelming at times be
4338
* **Links and references**:
4439
* Are all links working correctly?
4540
* Are references properly cited?
46-
* **Code and examples**:
47-
* Do code snippets work as expected?
48-
* Are examples relevant and effective?
41+
* **Examples**:
42+
* Do the real-world examples effectively enhance the understanding of the documentation's topic?
43+
* Do the real-world examples resonate with the user?
4944

5045
## Conclusion
5146

0 commit comments

Comments
 (0)