Skip to content

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

Closed

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.

Activity

  1. fedeoliv commented on Oct 16, 2026

    @fedeoliv
    ContributorAuthor

    Implementation verified, pending merge.

    Added plain-vocabulary guidance with concrete examples, including location instead of locus, use instead of utilize, and make easier instead of facilitate. Precise domain terminology, API names, identifiers, and quotations remain intact. Updated the shared skill, repository and distributed instruction pointers, and published quality documentation.

    Validation: npm --prefix docs run build passed with 40 pages, and git diff --check passed. Changed Markdown has no new lint diagnostics compared with HEAD. Template verification remained identical to the existing baseline.

    Branch: feature/40-plain-language.
    Commit: 17492577133cb1d8de84c74fc96487a107330a72.
    PR: #77.

    Changes are committed and pushed. The issue remains open until merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentationstatus:in-progressImplementation is in progress

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions