Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion capabilities/documentation-quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Generally, an overall score equal to or less than 3 means you'll likely gain a l

The following is a curated list of supporting practices to consider when looking to improve your team's Documentation Quality capability. While not every practice will be beneficial in every situation, this list is meant to provide teams with fresh, pragmatic, and actionable ideas to support this capability.

### [Introduce a Screen Recording Tool](/practices/introduce-a-screen-recording-tool.md)

A screen-recording tool supports documentation quality by capturing details that text often misses, such as workflows, edge cases, and intent behind decisions. Because creating a video is fast and easy, teams can add clear, high-value context to tickets without slowing down their work. As these recordings become a routine part of documentation, the overall accuracy and clarity of requirements improve, reducing misunderstandings and rework.

### [Use Documentation Auto-Generation Tooling](/practices/use-documentation-auto-generation-tooling.md)

Automate the creation of documentation using tools that generate comprehensive and up-to-date documentation directly from the source code or configuration files. This practice ensures that documentation stays in sync with the codebase, reducing the manual effort required to maintain it, and minimizing the risk of outdated or incomplete information. Tools like [Swagger](https://github.com/swagger-api) create executable documentation, while tools like [RepoAgent](https://github.com/OpenBMB/RepoAgent) use LLMs to automatically keep the documentation in sync as the codebase changes.
Expand All @@ -55,7 +59,7 @@ Runbooks provide step-by-step guidance that helps teams resolve issues quickly a

### Introduce a Screen-Recording Tool

By enabling richer, more intuitive communication, screen recording helps teams document intent more clearly, reduce back-and-forth, and improve the efficiency of handoffs without requiring ticket authors to spend a lot of time writing. A lightweight screen-recording tool like [Loom](https://www.loom.com) allows ticket authors to quickly demonstrate the issue or desired behavior using voice and visuals, reducing ambiguity without adding process overhead.
By enabling richer, more intuitive communication, screen recording helps teams document intent more clearly, reduce back-and-forth, and improve the efficiency of handoffs without requiring ticket authors to spend a lot of time writing. A lightweight screen-recording tool like [Loom](https://www.loom.com) allows ticket authors to quickly demonstrate the issue or desired behavior using voice and visuals, reducing ambiguity without adding process overhead.

## Adjacent Capabilities

Expand Down
6 changes: 5 additions & 1 deletion capabilities/learning-culture.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,17 @@ Talking directly with users is an invaluable practice for gaining insights and u

Dogfooding your systems involves having your teams use the same products or systems that your users do, allowing them to experience the same pain points firsthand. This practice helps build empathy with users, identify issues early, and drive improvements based on direct "user" experience. By regularly using your own systems as customers would, your team can gain valuable insights and ensure that the product meets the highest standards of usability and performance.

### [Introduce a Screen Recording Tool](/practices/introduce-a-screen-recording-tool.md)

A screen-recording tool supports a learning culture by making it easy to create and share videos that carry far more context and nuance than text alone. When recording becomes effortless, teammates naturally default to richer explanations that help others understand intent, reasoning, and edge cases. As this practice becomes a norm, the flow of high-quality information increases, giving the team more opportunities to learn from each other.

### [Use SPIN To Unearth Problems and Solutions](/practices/use-spin-to-unearth-problems-and-solutions.md)

SPIN is a question-asking framework that was originally developed for sales professionals. It focuses on understanding a person's needs through four types of questions: Situation, Problem, Implication, and Need-Payoff. Software professionals can use SPIN to uncover problems, clarify needs, and arrive at creative solutions, thus bolstering a learning culture.

### Introduce a Screen-Recording Tool

By enabling richer, more intuitive communication, screen recording helps teams document intent more clearly, reduce back-and-forth, and improve the efficiency of handoffs without requiring ticket authors to spend a lot of time writing. A lightweight screen-recording tool like [Loom](https://www.loom.com) allows ticket authors to quickly demonstrate the issue or desired behavior using voice and visuals, reducing ambiguity without adding process overhead.
By enabling richer, more intuitive communication, screen recording helps teams document intent more clearly, reduce back-and-forth, and improve the efficiency of handoffs without requiring ticket authors to spend a lot of time writing. A lightweight screen-recording tool like [Loom](https://www.loom.com) allows ticket authors to quickly demonstrate the issue or desired behavior using voice and visuals, reducing ambiguity without adding process overhead.

## Adjacent Capabilities

Expand Down
48 changes: 48 additions & 0 deletions practices/introduce-a-screen-recording-tool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Introduce a Screen-Recording Tool

An unfortunate reality is that tickets are often vague, lack clear acceptance criteria, or rely heavily on assumed knowledge. This leads to frequent misunderstandings, rework, and delays, particularly for newer team members who are unfamiliar with the system or business context. A lightweight screen-recording tool, like [Loom](https://www.loom.com/screen-recorder), allows ticket authors to quickly demonstrate the issue or desired behavior using voice and visuals, reducing ambiguity without adding process overhead.

## When to Experiment

“I am a developer and I need to ensure that my communication is intuitive so that I can document intent more clearly and reduce back-and-forth.”
"I am a developer and I need to learn how to write tickets quicker so that I can improve efficiency of handoffs."

## How to Gain Traction

[to be completed by Pragmint]

List 3–5 steps to take a team from zero to adopted.
For each step, include:
### [Action Step]
3 sentences on how to do it, how to get buy-in, and what tools/resources help. Any external resources (videos, guides, book lists, templates, etc.) that help a team adopt this practice should be linked here within the relevant action step.

## Lessons From The Field

[to be completed by Pragmint]

This section captures real-world patterns (things that consistently help or hinder this practice) along with short, relevant stories from the field. It’s not for personal rants or generic opinions. Each entry must be based on either:
1. a repeated observation across teams, or
2. a specific example (what worked, what didn’t, and why).

## Deciding to Polish or Pitch

After experimenting with this practice for [insert appropriate quantity of time in bold], bring the team together to determine whether the following metrics and/or signals have changed in a positive direction:

### Fast & Measurable

You should see **increased use of screen recordings in JIRA**, indicating the practice is gaining traction.

You should see a **reduction in synchronous clarification meetings**, freeing up time across roles.

You should see **faster lead time of tickets**.

### Slow & Measurable

You should see **fewer QA rejections or rework cycles** due to unclear requirements.

## Supported Capabilities

### Learning Culture (link)
1–2 sentences on how this practice helps improve it.

### Documentation Quality (link)