Skip to content

Commit beb838c

Browse files
authored
fix: revise the introduction
1 parent cc17d31 commit beb838c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# How to be a great peer reviewer
22

3-
When you first start your technical writing journey, one of the many important skills you'll need to learn is how to do is peer reviews. It's a skill that will not only teach you how to collaborate with other technical writers and other people who interact with documentation, but it will also help you to become a better technical writer in the long run.
3+
The goal of reviewing is to make sure the content is accurate and the strongest version of itself—for now. Online documentation will change, so it’s important to stay focused as you write.
4+
5+
One key skill to build early in your technical writing journey is peer reviewing. It helps you collaborate effectively with other writers and stakeholders, and it strengthens your own writing over time.
46

57
## Tips for doing effective Peer Reviews
68

@@ -42,6 +44,5 @@ When it comes to peer reviews, it can get confusing and overwhelming at times be
4244
* Do the real-world examples effectively enhance the understanding of the documentation's topic?
4345
* Do the real-world examples resonate with the user?
4446

45-
## Conclusion
4647

47-
The end goal of reviewing is to make sure that the work is a) correct/accurate, and b) the best version of itself (for now). The nature of online documentation is that it's 100% going to change at some point, so it's important to keep a good eye on the work as it's being written
48+

0 commit comments

Comments
 (0)