Back to all reviewers

Documentation clarity standards

sveltejs/svelte
Based on 4 comments
Markdown

Ensure technical documentation clearly distinguishes between similar but different concepts, uses precise language, and provides unambiguous explanations. When documenting Vue features, explicitly label and differentiate between reactive and non-reactive data, different directive behaviors, and component patterns.

Vue Markdown

Reviewer Prompt

Ensure technical documentation clearly distinguishes between similar but different concepts, uses precise language, and provides unambiguous explanations. When documenting Vue features, explicitly label and differentiate between reactive and non-reactive data, different directive behaviors, and component patterns.

Use clear, descriptive comments in code examples to highlight important distinctions:

// reactive data - changes trigger re-renders
const reactiveUser = reactive({name: "Alice", age: 18});

// plain object - changes do not trigger re-renders  
const plainUser = {name: "Bob", age: 21};

Avoid ambiguous phrasing that could confuse readers about technical behavior. Choose words that clearly convey the intended meaning and relationship between concepts. Review documentation for grammatical errors and ensure consistent terminology throughout.

4
Comments Analyzed
Markdown
Primary Language
Vue
Category

Source Discussions