To: Dhara, Technical Writing Team Member
From: Christine, Technical Writing Team Member
Date: Feb 4th, 2022
Peer Review / Term: Algorithm
Congratulations, and thank you for posting the 1.3 assignment. Please consider reading through the peer review document below with suggestions for improvement.
First Impressions:
This impressive document includes a well-organized structure, good visual cited adequately, and propitiate reference list.
Organization:
- Excellent work on organizing the document to make it pleasant to read.
- An Introduction with detailed information
- The bolded heading is easy to read
- Figures with correct citation
Expression:
- The understanding of the definition is well expressed throughout the entire document.
- Overall, the tone is friendly and professional; however, if the document could be more concise, it could make the points more transparent.
- Some sentences can be more direct. For example:
- “A common example of an algorithm is a cake recipe, where a sequence of steps are followed to accomplish the task of baking a cake.”
- The passive voice and the wordy preface can create a clarity problem.
- Rewrite example: A cake recipe is a typical example of an algorithm; making cakes takes a sequence of steps.
- “All algorithms can be produced with just three basic building blocks: sequence selection and interaction.”
- Rewrite example: Sequence, selection, and iteration are the three basic building blocks to produce algorithms.
- “A common example of an algorithm is a cake recipe, where a sequence of steps are followed to accomplish the task of baking a cake.”
Content:
- The document followed the instruction of the 1.3 assignment, which includes
- Summary of the assignment; introduction
- The situation indicates the potential audience
- Three forms of definition: parenthetical definition, sentence definition, and expanded definition
- Four types of expansion definition
- One visual
- A reference list in MLA format
- Include the ‘why’ Algorithms are used in computing.
Visuals:
- Well done on the visual.
- The picture is well explained, labelled and cited.
Work Cited List:
- Excellent on the work cited list- however, a small error occurred.
- Don’t forget to put “.” behind the name of the author
- Rewrite: Ashwani, KJunior. “Complete Tutorials of Introduction to Algorithm.” DevOpsSchool.com, 10 June 2021, https://www.devopsschool.com/blog/complete-tutorials-of-introduction-to-algorithm/
Grammar and Typos:
- There are several minor grammar errors; one example is: “A common example of an algorithm is a cake recipe, where a sequence of steps are followed to accomplish the task of baking a cake.”
- Please note that “a sequence of steps” is singular and “are” is plural; this needs correction.
Concluding Comments:
Thank you! It’s been a pleasure to review your definition document that is informative and well organized. With the following suggestions, this will be an excellent document:
- Self-editing for clarity is needed:
- Grammar
- Choice of passive or active voice
Thank you for your time in reading through the peer review document. Please feel free to ask any questions.
Cheers.
