microsoft / microsoft/devsquad-copilot

[documentation-style] Prefer plain wording accessible to non-native speakers

Open Beginner friendly
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
No language data
Stars
44
Forks
10
Avg merge
6h 49m
Merged PRs (30d)
1

Description

Prefer simple, widely understood wording over sophisticated or academic terms so a global audience including non-native English speakers can follow easily.

Example to avoid: "locus" (academic Latin).

Acceptance criteria

  • Documentation style guidance recommends plain vocabulary and gives examples of terms to avoid.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or entry point is named. Locate the repository’s existing documentation style guidance and review how wording recommendations are organized. Add guidance favoring plain, widely understood vocabulary, including an example such as “locus,” and verify that the acceptance criteria are covered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.