Skip to content

Commit c3b1c44

Browse files
authored
Merge pull request #5 from DataRecce/update-overall-overview
update overall overview with new images and content
2 parents 30839fa + 26d2d11 commit c3b1c44

File tree

4 files changed

+82
-44
lines changed

4 files changed

+82
-44
lines changed
181 KB
Loading
91.7 KB
Loading
246 KB
Loading

docs/index.md

+82-44
Original file line numberDiff line numberDiff line change
@@ -4,86 +4,124 @@ icon: material/hand-wave-outline
44
---
55

66

7-
# What is **Recce**?
7+
# What is Recce?
88

9-
**Recce** (/ˈrɛki/), pronounced 'reh-kee', is short for 'reconnaissance'. It's a data change management toolkit designed to enhance the pull request (PR) review process for dbt projects. **Recce** provides enhanced visibility into the data impact from dbt modeling changes by comparing the data in dev and production environments. Using Recce for data impact assessment before merging a PR ensures that production data remains stable and accurate.
9+
Recce (pronounced "wreck-E"), short of reconnaissance, helps data teams cut guesswork on downstream impact, streamline collaboration, and ship changes faster—building trust through clarity.
1010

11-
## Key Features
11+
## Quick Start
1212

13-
### Manual and Automated Data Checks
13+
You can launch Recce in any dbt project in just two commands:
1414

15-
**Recce** checks help you to assess data impact and explore data change both manually and automatically.
15+
```bash
16+
# cd into your dbt project
17+
pip install -U recce
18+
recce server
19+
```
1620

17-
- **Manual checks** - Create a **Recce** <a href="https://medium.com/inthepipeline/build-a-checklist-for-better-dbt-pr-review-913906ff11dd" target="blank">Checklist</a> of data checks that help to validate your data modeling work during development, including data profile comparisons, structural comparisons, and row-level data checks.
18-
- **Automated checks** - Integrate **Recce** Checks into your CI process and post a data impact summary automatically to your PR thread when opening a PR.
21+
This starts Recce locally, where you can explore lineage and run queries. To unlock the full set of diffing tools, such as data comparisons and impact checks, you’ll need to prepare two environments to compare against. You can follow our [5-minute Jaffle Shop tutorial](https://datarecce.io/docs/get-started-jaffle-shop/) to try it out step-by-step.
1922

20-
### Collaboration and Replication
23+
Recce is the foundation of the workflow. It helps you explore changes, validate before merge, and provide full context to reviewers and stakeholders. Once you're comfortable using it locally, you can explore advanced collaboration features through Recce Cloud.
2124

22-
Share **Recce** checks with your team for stakeholder and PR review. Checks results can be either [shared individually](features/lineage.md#screenshot), or your full **Recce** <a href="https://medium.com/inthepipeline/enhanced-dbt-pr-review-with-reproducible-data-validation-environments-e6c37a15908f" target="_blank">environment can be exported</a> and [replicated with one command](features/state-file.md#review-the-state-file).
25+
### Explore the Live Demos
2326

27+
Want to see Recce in action without setting anything up? Try it with real pull requests from the Jaffle Shop demo project.
28+
29+
Each PR shows how Recce helps validate dbt model changes with lineage, diffs, and review checklists.
30+
31+
- [PR #1](https://github.com/DataRecce/jaffle_shop_duckdb/pull/1) – Fixing logic in Customer Lifetime Value
32+
- [PR #2](https://github.com/DataRecce/jaffle_shop_duckdb/pull/2) – Refactoring for clarity
33+
- [PR #3](https://github.com/DataRecce/jaffle_shop_duckdb/pull/3) – Adding rounding analysis
34+
- [PR #44](https://github.com/DataRecce/jaffle_shop_duckdb/pull/44) – Enhancing the customers model
35+
- [PR #46](https://github.com/DataRecce/jaffle_shop_duckdb/pull/46) – fixing metrics, rebuilding trust
2436

2537
## Why Recce
2638

27-
dbt has brought software engineering best practices to data projects, but “bad merges” still happen, allowing erroneous data and silent errors to make their way into prod data.
39+
[dbt](https://www.getdbt.com/) introduced software best practices to data projects: modular SQL, version-controlled code, and reproducible pipelines.
2840

29-
### Understand data impact
41+
But “bad merges” still happen. Silent data errors slip through. Trust breaks when the metrics break.
3042

31-
**Recce** provides data and analytics engineers with a toolkit to explore data impact caused by dbt data modeling changes. The varying levels of **Recce** checks enable holistic or fine grained impact assessment so you can drill down to find the root cause of data change.
43+
As teams scale and more people contribute to data projects, it becomes harder to validate changes with confidence, especially when the impact spans multiple models or business domains.
3244

33-
### Improved confidence merging
45+
Recce brings data reconnaissance into the workflow. Instead of hoping everything’s fine, you can:
3446

35-
The improved visibility into data impact gives PR reviewers the confidence to sign-off PRs knowing that prod data will not change unexpectedly.
47+
- Instantly trace dependencies down to the column level
48+
- Compare data and metrics before and after a change
49+
- Share a clear, explainable checklist with teammates and stakeholders
3650

51+
The only way to know the impact of a change is to compare what it actually changes. Recce makes that fast, visible, and collaborative.
3752

38-
<div style="position: relative; padding-bottom: 71.68758716875871%; height: 0;"><iframe src="https://www.loom.com/embed/f6ea8a9b37964cbd9821bb6896d3206f?sid=9c701279-08cd-45c5-b12d-e7967d8f898d" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
53+
## Who is Recce for?
3954

55+
Recce helps teams catch issues early, understand the impact of changes, and build trust in every deployment. It fits naturally into the data workflow so validation becomes part of how you build, not something extra to worry about.
4056

41-
## How Recce Works
42-
Recce works by comparing dbt model changes between two environments, which is essential for full impact analysis. However, you can still get started with Recce without first preparing a base environment.
57+
- **Data engineers** use Recce to check for downstream impact and make sure changes are safe before merging.
58+
- **Analysts** use Recce to review their own work, compare data before and after, and confirm that key metrics still make sense.
59+
- **Stakeholders** use Recce to review updates with clear context, without reading SQL or digging into warehouse tables.
4360

44-
### Quick start
61+
## What You Get
4562

46-
Launch Recce in any dbt project in just two commands:
63+
Recce gives you a clear, fast way to understand what your data changes are doing and why they matter. It helps you catch problems early, verify metrics, and share your findings with others, all as part of your normal workflow.
4764

48-
```yaml
49-
# cd into your dbt project
50-
pip install -U recce
51-
recce server
52-
```
65+
![Lineage graph supports model/column levels navigation and breaking change analysis](assets/images/home/lineage-readme1.png)
66+
67+
Lineage graph supports model/column levels navigation and breaking change analysis.
68+
69+
![Model and column level diff](assets/images/home/diff-readme2.png)
70+
71+
Model and column level diff
72+
73+
![Checklist for collaboration](assets/images/home/checklist-readme3.png)
74+
75+
Checklist for collaboration
5376

54-
In this mode, you can perform the following actions:
77+
### What’s included
5578

56-
- Explore lineage and navigate your dbt project
57-
- Track model changes with basic lineage diff
58-
- Run queries with Jinja and macros
79+
- **Lineage and impact mapping:** Quickly see which models and columns are affected by a change. Navigate lineage down to the column level, and spot breaking changes with clear visual cues.
80+
- **Metric and data comparisons:** Use Profile, Value, Top-K, and Histogram Diffs to compare results before and after changes. Validate things like row counts, category distributions, and numeric ranges without writing extra SQL.
81+
- **Query diff:** Write and compare any two queries side by side. This is helpful when validating fixes or reviewing changes with teammates.
82+
- **Checklist for reviews and approvals:** Turn your validation steps into a checklist. Add notes, rerun checks, and share the results with reviewers or stakeholders. In Recce Cloud, checklists can sync automatically and even block PRs until checks are approved.
83+
- **Secure by design:** Recce is SOC 2 compliant to meet enterprise security standards. It runs locally or in your private environment, and your data stays in your warehouse.
5984

60-
### Full comparison mode
85+
### Learn More
6186

62-
To use the full suite of diffing tools in Recce, set up a base dbt environment for Recce to compare against.
87+
Want to dive deeper? Check out the full documentation for setup guides, feature overviews, and use case tutorials.
6388

64-
See the [Getting Started](get-started.md) page for instructions on how to do this.
89+
- [Getting Started](https://datarecce.io/docs/get-started-jaffle-shop/)
90+
- [Features Overview](https://datarecce.io/docs/features/lineage/)
91+
- [Writing Checks and Using Checklists](https://datarecce.io/docs/features/checklist/)
92+
- [State File and Configuration](https://datarecce.io/docs/features/state-file/)
93+
- [Running Recce in CI/CD](https://datarecce.io/docs/guides/scenario-ci/)
94+
- [Breaking Change Analysis](https://docs.datarecce.io/features/breaking-change-analysis/)
6595

66-
## What you get
96+
## Recce Cloud
6797

68-
### Interactive impact assessment environment
98+
Ready to collaborate and move faster as a team? Recce Cloud adds real-time collaboration, automatic checklist sync, and PR gating, so nothing gets merged without a full review.
6999

70-
`recce server` launches a web UI with an [**interactive impact assessment environment**](features/lineage.md). Use the tools in **Recce** to explore the impact to your data models from your branch changes.
100+
- Share checklists across environments
101+
- Invite stakeholders to review data changes
102+
- Block merges until all Checks are approved
103+
- Launch demo links from your CI with full context
71104

72-
### Focused data impact exploration
105+
👉 [View Pricing and Plans](https://datarecce.io/pricing)
73106

74-
The main interface to **Recce** is the [lineage DAG](features/lineage.md#node-summary), which shows modified nodes and potentially impacted downstream nodes. You can quickly see if critical nodes are within the impact radius and focus your data validation efforts.
107+
Recce Cloud is a hosted version of Recce that standardizes your workflow, keeps teams aligned, and reduces errors—so you can ship data changes with confidence.
75108

109+
## Community & Support
76110

77-
<figure markdown>
78-
![Recce Lineage Diff](assets/images/recce-ui-elements.png)
79-
<figcaption> </figcaption>
80-
</figure>
111+
Here's where you can get in touch with the Recce team and find support:
81112

82-
## Getting Started
113+
- [dbt Slack](https://www.getdbt.com/community/join-the-community) in the [#tools-recce](https://getdbt.slack.com/archives/C05C28V7CPP) channel
114+
83115

84-
Try the [5-minute tutorial](get-started-jaffle-shop.md) that uses dbt’s Jaffle Shop project, or take the [online demo](demo.md) for a test run, which includes an actual PR and related Recce Instance.
116+
If you believe you have found a bug, or there is some missing functionality in Recce, please open a [GitHub Issue](https://github.com/DataRecce/recce/issues).
85117

118+
## Recce on the web
86119

87-
## What does **Recce** mean?
120+
You can follow along with news about Recce and blogs from our team in the following places:
88121

89-
**Recce** (/ˈrɛki/), pronounced 'reh-kee', is short for 'reconnaissance'. We chose this name as it's the perfect fit for a tool you'll use to perform a 'data reconnaissance' to discover and assess the impact of data modeling changes. Add a **Data Recce** to your pull request workflow and stop pushing breaking changes to production!
122+
- [DataRecce.io](https://datarecce.io/)
123+
- [LinkedIn](https://www.linkedin.com/company/datarecce)
124+
- [Medium blog](https://medium.com/inthepipeline)
125+
- [@datarecce](https://x.com/DataRecce) on Twitter/X
126+
- [@DataRecce@mastodon.social](https://mastodon.social/@DataRecce) on Mastodon
127+
- [@datarecce.bsky.social](https://bsky.app/profile/datarecce.bsky.social) on BlueSky

0 commit comments

Comments
 (0)