Understanding and Modifying Keypup’s Metric Documentation

Gain insights on understanding and modifying Keypup's metric documentation. Learn how to access and modify metrics' documentation, ensuring a comprehensive understanding of purpose, calculation, and improvement areas. Empower your team to make data-driven decisions and drive continuous improvement in software engineering practices with Keypup.

Celine Nabais
Celine Nabais LinkedIn
• 3 min read
Understanding and Modifying Keypup’s Metric Documentation

​In the realm of software engineering metrics, it's not uncommon for individuals who didn't create a particular metric to struggle with understanding how it has been calculated, why it matters, and how to improve it. This lack of clarity can hinder effective decision-making and impede progress within an organization. That's why documenting metrics is key to ensuring that everyone involved has a comprehensive understanding of the metric's purpose, calculation, and potential areas for improvement.

In this article, we’ll show you how to access and modify your metrics’ documentation.

1. To access any metric's documentation, click on the question mark (?) button located next to the insight title.

Image

2. This will open a tooltip that contains all the information about the insight. Keypup's metric templates come with default documentation that provides information about the insight and how it’s calculated, as well as tips to improve the metric.

Image

3. To modify the metric's documentation, click on the edit (...) button located at the top right of the insight.

Image

4. Then, select "Edit insight."

Image

5. Click on the "Document insight" section of the left navigation panel.

Image

6. From there, you can edit your documentation one-liner description as well as the full documentation to meet your organization’s needs and processes.

Image

8. Don't forget to save your changes.

Image

9. That's it. You can click on the question mark next to the insight title to read your updated documentation.

Image

Image

‍

Understanding and modifying Keypup's metric documentation is a powerful tool for organizations seeking to optimize their software engineering practices. By providing clear insights into metrics and offering the flexibility to tailor documentation to specific needs, Keypup enables teams to work collaboratively, make data-driven decisions, and drive continuous improvement.

With comprehensive metric documentation, organizations can build a foundation of understanding and alignment to drive efficiency and success in their software engineering endeavors. Leverage Keypup today to unlock the full potential of your software engineering metrics.

Ready to Transform Your Analytics?

Join teams already using AI to make data-driven decisions faster than ever.

Most Recent Articles

Timesheet Theater: Why Jira Time Logs Don't Match What Your Engineers Actually Built

Timesheet Theater: Why Jira Time Logs Don't Match What Your Engineers Actually Built

Software capitalization, client billing and R&D tax credits all run on Jira time logs that engineers fill in on Friday afternoon, from memory. Learn what engineering and finance leaders on Reddit say about time tracking nobody trusts, and how Keypup MCP compares Jira worklogs with linked pull requests, commits and merges to show when time is logged, how late it arrives, and which hours have code behind them.

Thomas Williams
The Hidden Queue: Why Most of Your Lead Time Happens Before the First Commit

The Hidden Queue: Why Most of Your Lead Time Happens Before the First Commit

Your pipelines got faster and your reviews got shorter, yet features still take months to reach customers. Learn what engineering leaders on Reddit say about work that waits weeks in Backlog, Ready for Development and To Do before anyone writes code, why delivery dashboards that start at the first commit miss it, and how Keypup MCP uses Jira workflow history, sprints and the commit and merge dates of linked pull requests to measure the queue in front of your code.

Liam Davis
Watermelon Status: Why Jira Says Done When Your Code Hasn't Merged

Watermelon Status: Why Jira Says Done When Your Code Hasn't Merged

Green on the outside, red on the inside. Learn what engineering leaders on Reddit say about Jira tickets moved to Done before the code ships, velocity that doesn't match delivery and status reports nobody trusts at enterprise scale, and how Keypup MCP compares each issue's closure date, workflow history and sprint with the state and merge dates of its linked pull requests to measure how much of your reported "Done" has no merged code behind it.

Stephane Ibos