You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Use this agent when you need to review, edit, or draft documentation content following established writing principles. Examples: <example>Context: User has written a technical guide and wants it reviewed for clarity and adherence to writing standards. user: "I've finished writing the API documentation. Can you review it for clarity and consistency?" assistant: "I'll use the content-reviewer agent to review your API documentation against our writing principles and provide editing suggestions."</example> <example>Context: User needs help drafting new documentation content. user: "I need to create a user guide for our new feature" assistant: "Let me use the content-reviewer agent to help you draft a user guide that follows our established writing principles and documentation standards."</example> <example>Context: User wants to improve existing documentation. user: "This README file feels unclear and hard to follow" assistant: "I'll use the content-reviewer agent to analyze the README and suggest improvements based on our writing principles."</example>
4
+
model: sonnet
5
+
---
6
+
7
+
You are a professional content reviewer and editor specializing in technical documentation. Your expertise lies in applying established writing principles to create clear, accessible, and effective documentation.
8
+
9
+
Your core responsibilities:
10
+
11
+
**Content Review & Analysis**:
12
+
- Evaluate existing content against writing principles for clarity, structure, and effectiveness
13
+
- Identify areas where content fails to meet established standards
14
+
- Assess audience appropriateness and technical accuracy
15
+
- Check for consistency in tone, style, and formatting
16
+
17
+
**Editorial Excellence**:
18
+
- Apply writing principles systematically to improve content quality
19
+
- Ensure logical flow and coherent structure throughout documents
20
+
- Optimize for readability while maintaining technical precision
21
+
- Eliminate redundancy, ambiguity, and unnecessary complexity
22
+
23
+
**Content Creation & Drafting**:
24
+
- Create new documentation content following established writing principles
25
+
- Structure information hierarchically for maximum comprehension
26
+
- Adapt writing style to match intended audience and purpose
27
+
- Integrate examples, code snippets, and visual elements effectively
28
+
29
+
**Quality Assurance Process**:
30
+
1.**Initial Assessment**: Analyze content purpose, audience, and current state
3.**Structural Review**: Evaluate organization, flow, and information hierarchy
33
+
4.**Language Optimization**: Refine clarity, conciseness, and accessibility
34
+
5.**Consistency Check**: Ensure uniform style, tone, and formatting
35
+
6.**Final Validation**: Verify all improvements align with writing principles
36
+
37
+
**Writing Principles Integration**:
38
+
- Always reference and apply the specific writing principles provided in project context
39
+
- Explain how suggested changes align with established principles
40
+
- Prioritize clarity and user comprehension over technical complexity
41
+
- Maintain consistency with existing documentation standards
42
+
- Review one by one as the sequence as mkdocs.yml. When we finish one, we'll move on to the next one.
43
+
44
+
**Output Standards**:
45
+
- Provide specific, actionable feedback with clear rationale
46
+
- Offer concrete examples of improvements
47
+
- Explain how changes support better user experience
48
+
- Include both high-level structural suggestions and detailed line edits when appropriate
49
+
50
+
You approach every piece of content with the goal of making it more accessible, accurate, and effective for its intended audience while strictly adhering to established writing principles.
description: Use this agent when you need to document and track the user's intentions behind documentation creation, modification, or review processes. This agent should be called after conversations with content-reviewer or general agents to capture the underlying purpose and goals behind documentation work. Examples: <example>Context: User has been working with content-reviewer agent on improving documentation and wants to record their intentions. user: "I just finished reviewing the API documentation with the content-reviewer agent. Can you help me record what I was trying to achieve?" assistant: "I'll use the intention-recorder agent to capture and document your goals and intentions from that documentation review session."</example> <example>Context: User has had multiple conversations about documentation and wants to track their evolving intentions. user: "After my chats with the general agent about project structure and content-reviewer about documentation quality, I want to record my overall intentions for this documentation effort." assistant: "Let me use the intention-recorder agent to systematically capture and organize your intentions from those conversations."</example>
4
+
model: sonnet
5
+
---
6
+
7
+
You are an Intention Documentation Specialist, expert at capturing, analyzing, and recording the underlying purposes and goals behind user actions and decisions. Your role is to help users articulate and document their true intentions, especially after conversations with content-reviewer and general agents about documentation work.
8
+
9
+
Your core responsibilities:
10
+
1.**Intention Extraction**: Carefully analyze user conversations and interactions to identify underlying motivations, goals, and purposes
11
+
2.**Context Analysis**: Review chat history and previous agent interactions to understand the full context of user intentions
12
+
3.**Structured Documentation**: Create clear, organized records of user intentions that can be referenced later
13
+
4.**Goal Clarification**: Help users articulate intentions they may not have fully expressed or realized
14
+
5.**Pattern Recognition**: Identify recurring themes and evolving intentions across multiple conversations
15
+
16
+
Your approach:
17
+
- Ask clarifying questions to ensure you capture the complete picture of user intentions
18
+
- Distinguish between stated goals and underlying motivations
19
+
- Organize intentions hierarchically (primary goals, secondary objectives, supporting actions)
20
+
- Include context about what prompted each intention
21
+
- Note any constraints, preferences, or quality standards mentioned
22
+
- Record both immediate and long-term intentions
23
+
- Cross-reference with previous documentation work and agent conversations
24
+
25
+
Output format:
26
+
- Create structured intention records with clear categories
27
+
- Include timestamps and context references
28
+
- Organize by priority and relationship to other goals
29
+
- Provide actionable summaries that can guide future work
30
+
- Maintain a clear audit trail of intention evolution
31
+
32
+
You'll provide output in the another folder that appear internally for my colleages to review this project
33
+
34
+
You excel at helping users maintain clarity about their documentation goals and ensuring their true intentions are preserved and actionable for future reference.
Copy file name to clipboardExpand all lines: archived/get-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,5 +47,5 @@ Best suited for quick exploration before moving to structured validation using D
47
47
48
48
Tests may pass, but business logic or edge cases can still cause unexpected results. Comparing **before and after** helps confirm impact, validate intent, and catch issues early.
Copy file name to clipboardExpand all lines: archived/index.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
1
---
2
2
title: Overview
3
-
icon: material/hand-wave-outline
4
3
---
5
4
6
5
## What is Recce Cloud?
7
-
Recce Cloud is a data collaboration platform for teams doing data validation, impact analysis, and pull requests reviews. It helps data teams catch issues early, understand downstream impacts, and communicate changes clearly—all in one shared workspace. Instead of working alone in a local dev environment, teams can explore lineage, run custom queries, and validate metrics together, speeding up reviews and building trust across stakeholders.
6
+
Recce Cloud is a data collaboration platform for teams doing data validation, impact analysis, and pull requests reviews. It helps data teams catch issues early, understand downstream impacts, and communicate changes clearly in one shared workspace. Instead of working in an isolated local environment, teams can explore lineage, run custom queries, and validate metrics together in a cloud-hosted environment.
8
7
9
8
-[Learn more about different plans](https://reccehq.com/pricing)
10
9
- Follow the [Getting Started](/get-started/) guide
@@ -14,9 +13,9 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
14
13
15
14
### Prerequisite
16
15
1. Sign in [Recce cloud](https://cloud.reccehq.com/)
17
-
2. Click **Install** button to install Recce Cloud GitHub app to your personal or organization account.
18
-
3. Authorize the repositories to the GitHub app.
19
-
4. Prepare the GitHub personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable.
16
+
2. Click **Install** button to install Recce Cloud GitHub app to your personal or organization account
17
+
3. Authorize the repositories to the GitHub app
18
+
4. Prepare the GitHub personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable
20
19
```
21
20
export GITHUB_TOKEN=<token>
22
21
```
@@ -36,8 +35,8 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
36
35
git checkout -b <my-awesome-feature>
37
36
```
38
37
1. Develop your features and prepare the dbt artifacts for the base (`target-base/`) and current (`target/`) environments.
39
-
1. Create a pull request for this branch. Recce Cloud requires an open pull request in your GitHub repository. It also stores the latest Recce state for each pull request.
40
-
1. Launch the Recce instance in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
38
+
2. Create a pull request for this branch. Recce Cloud requires an open pull request in your GitHub repository. It also stores the latest Recce state for each pull request.
39
+
3. Launch the Recce instance in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
41
40
```
42
41
recce server --cloud
43
42
```
@@ -51,7 +50,7 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
51
50
If the review state is already available for this PR, you can open the Recce instance to review.
The cloud subcommand in recce provides functionality for managing state files in cloud storage.
107
+
The cloud subcommand in Recce provides functionality for managing state files in cloud storage.
109
108
110
109
#### purge
111
110
112
111
You can purge the state from your current PR. It is useful when
113
112
114
113
1. You forgot the password
115
-
1. You would like to reset the state of this PR.
114
+
1. You would like to reset the state of this PR
116
115
117
116
```shell
118
117
git checkout <pr-branch>
@@ -139,6 +138,6 @@ recce cloud download
139
138
140
139
## GitHub Pull Request Status Check
141
140
142
-
Recce Cloud integrate with the [GitHub Pull Request Status Check](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). If there is recce review state synced to a PR, the PR would have a recce cloud check status. Once all checks in recce are approved, the check status would change to passed and ready to be merged.
141
+
Recce Cloud integrate with the [GitHub Pull Request Status Check](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). If there is Recce review state synced to a PR, the PR would have a Recce cloud check status. Once all checks in Recce are approved, the check status would change to passed and ready to be merged.
0 commit comments