GA doc page - #678
Conversation
Deploying docs with
|
| Latest commit: |
6cc25ff
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fe97c7ca.docs-c7r.pages.dev |
| Branch Preview URL: | https://issue-365.docs-c7r.pages.dev |
|
|
||
| **Global Analytics** provides a consolidated, company-wide view of your test engineering performance. It aggregates data from every project you can access within a company into a single prebuilt dashboard, allowing you to evaluate automation coverage, success rates, and defect counts across projects without navigating into each one individually. | ||
|
|
||
| **Global Analytics** operates at the **Company level**. The aggregated metrics reflect all projects within the selected company. |
There was a problem hiding this comment.
please apply these changes if you consider them ok
I would write a bit simpler, not using words like aggregated metrics
so instead of this
Global Analytics operates at the Company level. The aggregated metrics reflect all projects within the selected company.
we can write
Global Analytics works at the company level, so the numbers cover all projects in the company you have selected.
|
|
||
| ::: | ||
|
|
||
| ## How to Access Global Analytics |
There was a problem hiding this comment.
in the headings/subheadings, we can use imperative and laconic phrasing, like
Access Global Analytics
please apply this heading
There was a problem hiding this comment.
@catpetrychenko-rgb we use this format of headings/subheadings for many years. Is it really that bad?
There was a problem hiding this comment.
@TetianaKhomenko
not bad, it is not metter of bad
when every heading starts with the same words, those words stop telling the user anything
user scan past "How to" each time to find the part that's different, and in a long list it's easy to miss the article you need even when it's right in front of you.
instead, starting with the word that's unique, like "Access Global Analytics", makes each one stand out on its own.
moreover, the word should be in imperative form - like do this
I searched for this question more deeply
Google's style guide suggests the same for task headings: "Create an instance" rather than "Creating an instance," like here https://developers.google.com/style/headings
There was a problem hiding this comment.
great, thanks for the explanation
|
|
||
| :::note | ||
|
|
||
| Stat Counts exclude **detached tests**(automated tests whose underlying code signature no longer matches the repository). They are left out so they do not inflate your totals. |
There was a problem hiding this comment.
please add the SPACE before (
detached tests**(
like this
detached tests** (
it is not a big deal, but it is better to change
| - **Detached test** — an automated test that no longer matches code in the repository. Detached tests are excluded from the test counts. | ||
| - **Priorities** — tests carry one of five priorities: low, normal, important, high, and critical. The priority breakdowns and the priority bar chart use these. | ||
|
|
||
| ## How the Data is Gathered |
There was a problem hiding this comment.
Please consider writing titles shorter
Data Collection
|
|
||
| **Dashboards** operate at the **Company level**, aggregating test data across all projects in the selected company. | ||
|
|
||
| ## How to Create a Dashboard |
There was a problem hiding this comment.
please write a bit shorter here, like
Create a Dashboard
|
|
||
| ::: | ||
|
|
||
| ## How to Add the Widget |
There was a problem hiding this comment.
please write
Add the Widget
| - **Single value** — one headline number, such as total automated tests. | ||
| - **Bar chart** and **multi-bar chart** — compare values across categories or projects. | ||
| - **Pie chart**, **multi-pie chart**, and **circle (donut) chart** — show a breakdown as parts of a whole, such as passed, failed, and skipped. | ||
| - **Timeline** — plot a metric over time to see trends. | ||
| - **Table** — list raw rows, such as per-project or per-priority figures. | ||
| - **Project stats** — a comprehensive card for one project: test counts, automation rate, success rate, and defects by priority. | ||
| - **Run stats** — a summary of run outcomes. | ||
| - **Partial total** — a progress indicator that shows part of a total, such as executed versus planned. | ||
| - **Milestone views** — dedicated layouts for a milestone's run stats, tests, plans, and requirements. |
There was a problem hiding this comment.
please, if something needs to be explained, use the tables, as it is visually easier for the user to understand the information there
like this
| Visualization | What it shows |
|---|---|
| Single value | One headline number, such as total automated tests. |
| Bar chart / multi-bar chart | Values compared across categories or projects. |
| Pie chart / multi-pie chart / circle (donut) chart | A breakdown as parts of a whole, such as passed, failed, and skipped. |
| Timeline | A metric plotted over time, to see trends. |
| Table | Raw rows, such as per-project or per-priority figures. |
| Project stats | A full card for one project: test counts, automation rate, success rate, and defects by priority. |
| Run stats | A summary of run outcomes. |
| Partial total | A progress indicator showing part of a total, such as executed versus planned. |
| Milestone views | Layouts for a milestone's run stats, tests, plans, and requirements. |
catpetrychenko-rgb
left a comment
catpetrychenko-rgb
left a comment
There was a problem hiding this comment.
please take a look at the comments. thank you!
3 participants
No description provided.