Quality Assessment

Quality.json

{
    "recommendations": [
      {
        "id": 1,
        "tsgReference": "2. If the ErrorCount generated in step 1 has a value larger than 0, enrich the incident with the following message \"Errors were found in Resource Central\".\n\n3. If the ErrorCount is 0, you can close the incident.\n",
        "tsgPosition": {
          "startLine": 1,
          "endLine": 1,
          "startOffset": 0,
          "endOffset": 765
        },
        "tsgGap": "The conditional block covers ErrorCount > 0 and ErrorCount = 0, but does not specify what to do if the query fails to run or returns an unexpected/null value.",
        "tsgFix": "Add a condition describing what should be done if the Kusto query does not execute successfully or returns an unexpected or null ErrorCount.",
        "suggestedChange": "2. If the ErrorCount generated in step 1 has a value larger than 0, enrich the incident with the following message \"Errors were found in Resource Central\".\n\n2a. If the query fails to run or ErrorCount is null/unexpected, diagnose query execution or escalate as appropriate.\n\n3. If the ErrorCount is 0, you can close the incident.\n",
        "rule": "condition-coverage",
        "category": "completeness",
        "severity": {
          "quality": "low",
          "automatability": "moderate"
        }
      },
      {
        "id": 2,
        "tsgReference": "1. Run the Kusto query below. The query will return ErrorCount, which refers to the amount of errors found in AzRC.",
        "tsgPosition": {
          "startLine": 1,
          "endLine": 1,
          "startOffset": 164,
          "endOffset": 279
        },
        "tsgGap": "The step does not describe how to interpret the ErrorCount value beyond whether it is greater than 0 and does not clarify what would constitute an abnormal or expected range. No expected output sample or diagnostic context is given.",
        "tsgFix": "Add information describing what typical ErrorCount values are, how to interpret them, and what additional diagnostics may be warranted if the count is unexpectedly high.",
        "suggestedChange": "1. Run the Kusto query below. The query will return ErrorCount, which refers to the amount of errors found in AzRC. Include notes about what typical ErrorCount values are, their expected ranges, and how to interpret abnormal results. If the ErrorCount is unusually high, consider gathering additional diagnostic details (e.g., error types, timestamps).",
        "rule": "diagnosis",
        "category": "content",
        "severity": {
          "quality": "high",
          "automatability": "high"
        }
      },
      {
        "id": 3,
        "tsgReference": "# Escalation Scenario",
        "tsgPosition": {
          "startLine": 1,
          "endLine": 1,
          "startOffset": 655,
          "endOffset": 676
        },
        "tsgGap": "The escalation section does not request collecting or providing diagnostic information to facilitate escalation, such as logs or output relevant to the incident.",
        "tsgFix": "Add a note to provide relevant diagnostic information (such as the query output or logs) when escalating issues.",
        "suggestedChange": "# Escalation Scenario\n\nWhen escalating, be sure to include relevant diagnostic information (such as the ErrorCount output from step 1 and any related logs) to help with resolution.\n",
        "rule": "diagnosis",
        "category": "content",
        "severity": {
          "quality": "high",
          "automatability": "high"
        }
      },
      {
        "id": 4,
        "tsgReference": "```kusto\ncluster(\"https://azurecm.kusto.windows.net\").database(\"AzureCM\").AzRCServerError\n| where TIMESTAMP > ago(1d)\n| count as ErrorCount\n```",
        "tsgPosition": {
          "startLine": 1,
          "endLine": 1,
          "startOffset": 0,
          "endOffset": 0
        },
        "tsgGap": "The cluster and database values are hard-coded, but the TSG does not clarify whether they should be replaced dynamically for different incidents. If dynamic replacement is required, placeholders should be used instead of hard-coded values.",
        "tsgFix": "If the cluster and database values need to be replaced according to the incident context, update the query to use descriptive placeholders (e.g., <cluster_url>, <database_name>). Otherwise, clarify in the guide that these values are fixed and do not require replacement.",
        "suggestedChange": null,
        "rule": "placeholders",
        "category": "content",
        "severity": {
          "quality": "low",
          "automatability": "moderate"
        }
      },
      {
        "id": 5,
        "tsgReference": "# Background\n\nThis TSG is used to check if there are any error messages in Resource Central.",
        "tsgPosition": {
          "startLine": 1,
          "endLine": 1,
          "startOffset": 0,
          "endOffset": 765
        },
        "tsgGap": "The title 'Background' is generic and does not describe the troubleshooting scope or problem addressed by the guide.",
        "tsgFix": "Replace the title with a descriptive heading that summarizes the troubleshooting focus, such as checking for errors in Resource Central.",
        "suggestedChange": "# Troubleshooting Resource Central Error Messages\n\nThis TSG is used to check if there are any error messages in Resource Central.",
        "rule": "title",
        "category": "structure",
        "severity": {
          "quality": "moderate",
          "automatability": "N/A"
        }
      }
    ],
    "evaluations": [],
    "assessmentResult": null
  },
  "createdOn": "2026-04-14T21:46:50.2066446+00:00"
}