Reviewer Guide

Reviewers are responsible for editing and maintaining Yearn Documentation resources. All writers and contributors are welcome to assume the Reviewer role.

This guide introduces the review process and outlines editing standards. Yearn expects its Writers and Reviewers to adhere to the principles described within this guide and all other contributor guides.

Please Note:

Reviewers should be comfortable working with Google Docs and HackMD. They should be open to learning the basics of Markdown, GitHub, and VSCode.

Reviewer Roles

Reviewer roles for Community Development projects are divided into three categories.

Tone | Grammar

Reviewers assess content and resources for tone and consistency. They ensure that all documents adhere to the Writing Style Guide.

• This role does not require in-depth knowledge about Yearn.

Content | Concepts

Reviewers edit content and make sure that all ideas presented are factual and easy to comprehend.

• Content Reviewers should have a deeper understanding of Yearn and its functions.

Maintenance

Reviewers refer to document-specific maintenance guides to make sure that existing documents are standardized and up to date.

• Check GitHub for a document-specific maintenance guide before working on an existing resource.

General Expectations

• Reviewers should be proficient writers with some background knowledge of cryptocurrencies and Yearn
• They should be familiar with the Comm-Dev contributor guides.
• By and large, all contributors should focus on effective collaboration.

Please Note:

The Reviewer’s top priority is to make sure that concepts are clearly expressed, and that the writing and tone adhere to the Writing Style Guide.

Reviewing an Existing Project

The guideline below offers general advice to ease the Reviewer's work process.

• Existing documents may be at any stage:
  • Google Doc
  • HackMD
  • VSCode
  • Live on GitHub
• Give existing documents a full read-through before starting work.
• When possible, improve the clarity and presentation of the material.
• Check for and correct any typos, grammatical errors, and deviations from the Writing Style Guide.
• Expand on and update concepts as Yearn grows.
  • Incorporate new developments within Yearn.
  • Update documents to reflect the latest terminology and language as Yearn grows and standards change.
• Add cross-linking to relevant resources.
• Take into account that final iterations are converted to Markdown and published on GitHub.
  • Avoid including direct links in a Google Doc.
    • Use the Markdown format to simplify conversion later on.
    • Example: [link](https://link.com)
• Use the Google Docs heading presets.
  • These work well with tools that convert documents into Markdown.
  • Headings can also help structure a document.
    • Google's outline tool follows the preset header formats.