Suggestion rulesActive

Use acronyms consistently

acronym-consistency

Detects repeated use of an expanded term after its acronym has already been introduced.

Usage of this metric

When enabled and matches are found, the report contains one item with this metric_id in result.suggestions. Absence means no match was found, not that the metric was not evaluated.

Location in the resultresult.suggestions[]metric_id = "acronym-consistency"

Calculation method

After identifying an acronym and expansion at first occurrence, checks whether the full expanded term appears again later.

Result interpretation

Each `occurrences` item identifies an affected span. `start` is inclusive and `end` exclusive, both measured in Unicode code points over the submitted text. `replacement`, `alternatives` and `edits` contain values only when a safe change is available. Absence means no match was found, not necessarily that the text is correct.

Limitations

This is a review signal, not an automatic correction or a complete assessment of text quality.

Dependencies

language: en
implementation_version: 1.2

Valid example

{
  "category": "lexical",
  "examples": null,
  "explanation": null,
  "id": "sug_1",
  "implementation_version": "1.2",
  "metric_id": "acronym-consistency",
  "metric_title": "Use acronyms consistently",
  "occurrences": [
    {
      "alternatives": [],
      "edits": [],
      "end": 25,
      "id": "occ_1",
      "paragraph_index": 0,
      "replacement": null,
      "sentence_index": 0,
      "start": 18,
      "text": "example"
    }
  ],
  "recommendations": [
    "Review the detected fragment in context."
  ],
  "severity": "warning",
  "summary": "Example detection returned by this metric."
}

GET /v1/metrics/acronym-consistency

Complete request, response and error contracts, generated automatically from the code.

Open the JSON record