This section discusses guidelines for organizing metric documentation pages and contained tables. The contents cover:

Detail follows in the sections below.

Business Rule Text Patterns

The business rules have several repeating patterns to convey similar information. This section provides "templates" for the most common patterns:

Student Level Metric Template

The <Metric Name> metric shows the <verbal description of the metric definition>

The metric is calculated for the following reporting periods:

Last X days
Last Y days
Year to Date
Prior Year (when data is available)

The last X and Y days are configurable at the district level.

For this metric, the following information is displayed:

Metric value for each reporting period, which is colored red or green to indicate if the value met or did not meet the student goal
Trend indicating whether the metric value for the reporting period is getting better or getting worse compared to the previous reporting period
Student Goal defined for the metric
Difference From Goal between the student’s metric value and the student goal

Historical Chart Template

The Historical Chart displays the metric value for the following historical reporting periods:

Grading period
Term
School year

The graph also shows the student goal and whether the metric value meets the goal for the selected reporting period. A green bar indicate the metric value met the student goal and a red bar indicates the metric value did not meet the student goal.

Grade Level Chart Template

The Grade Level Chart shows the metric value by grade level. A grade level chart is available for the following reporting periods:

Last X days
Last Y days
Year to Date
Prior Year (when data is available)

The last X and Y days are configurable at the district level.

The graph also shows the school goal and whether the metric value for each grade level meets the goal. A green bar indicates the metric value met the school goal and a red bar indicates the metric value did not meet the school goal.

Student List Template

The Student List displays the list of students who did not meet the student goal for this metric. The list always shows the student name, grade level, and metric value and is sorted alphabetically by default. Additional data is displayed in the list and users can customize the data that appears using the Customize View button. The list columns are also sortable.

Detailed Metric Pages - Page Outline & Queries

Below are the finalized formatting and layout for the detailed metric pages:

Current Metrics

Example: Student - Daily Attendance Rate
Page layout:
- Graphic
- Summary (H2)
  - Container Metric (H3)
    - JIRA Query with Summary, Description, MetricId, Key columns
  - Granular Metrics (H3)
    - JIRA query with Summary, MetricId, Key columns
- Business Rules (H2)
  - JIRA Query with Summary, Description, Testing Location, Key columns

Drill-Down Metrics

Example: Student - Daily Attendance Rates By Grading Period Chart
Page layout:
- Graphic
- Summary (H2)
  - JIRA Query with Summary, Description, Key columns
- Business Rules (H2)
  - JIRA Query with Summary, Description, Testing Location, Key columns

Conventions for Referencing Metrics in JIRA tickets

Metrics

Summary field:
- Hyphenate name - similar to TOC (e.g. Student - Daily Attendance Rate - Last X Days, Student - State Offenses - Historical Chart
- Add (Container) to the end of container metrics (e.g. Student - Daily Attendance Rate (Container))
Description field
- For container metrics : begin each Description entry by referring to the full metric (w/o hyphenation, and dropping "container") as follows "The xxxx metric is...". Examples:
  - The Student Daily Attendance Rate metric is… ( MET-721 - Getting issue details... STATUS )
  - The Student State Offenses metric is ...( MET-651 - Getting issue details... STATUS )
- For granular metrics : Not a priority since we don't surface "Description" on the Confluence page and the granular (X/Y, Min/Max) details are expected to be referenced in the container description
- For drill-down metrics : Refer to the drill-down metrics as referenced in the title (w/o hyphenation), but don't append "metric" at the end, i.e. "The xxx displays" e.g.:
  - The Student State Offences Historical Chart displays....( MET-512 - Getting issue details... STATUS )
  - The Student State Offences Incidents Log displays...( MET-796 - Getting issue details... STATUS )
Referencing definitions
- Where possible, use hyperlinks to refer to BR definitions in description fields. See MET-651 - Getting issue details... STATUS as an example, referencing "State Offense", and Last X, Y, YTD

Table Structure

This section outlines the layout for the various tables in the documentation, along with a brief explanation of each. Not every table appears on every page. For example, Container Metric generally appears on the "main" metric page while a Summary table appears on the more detailed pages. The tables are listed in the order they would appear on a page if all were present.

Generally speaking, the pattern is this:

First Column: Summary
Second Column: Description
...one or more other fields, depending on table type
Last Column: Key

Specific table type detail below.

Container Metric Summary

This table usually contains a single metric, the "container" for the page.

Column order:

Summary
Description
MetricId
Key

Granular Metrics

This table contains any metrics derived from the container metric. Note that there's no Description in this kind of table.

Column order:

Summary
MetricId
Key

Drill-Down Metric Summary

This table usually contains a single detailed metric.

Column order:

Summary
Description
Key

Business Rules

This table contains the detailed business rules that apply to the metric. Note that we've removed the "Status" from this kind of table.

Column order:

Summary
Description
Testing Location
Key

Browser not supported