Skip to content

Commit c5399ae

Browse files
committed
chore: add audit-note.md with detailed instructions for note file auditing process
This commit introduces a new documentation file that outlines a two-phase audit process for note files, including heuristic checks and deep analysis steps. It provides guidance on matching user queries to files, handling multiple matches, and determining implementation status within the codebase. The addition aims to standardize auditing procedures and improve consistency in assessments.
1 parent bc87285 commit c5399ae

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

.claude/commands/audit-note.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
You are tasked with auditing a single note file from "notes" folder.
2+
The folder path is: !`realpath $notes`
3+
4+
Available files:
5+
6+
<list>
7+
!`ls $notes/`
8+
</list>
9+
10+
You must find the file that most closely matches this user query: "$ARGUMENTS".
11+
12+
If there are multiple files matching, present user with a/b/c choice and wait for confirmation.
13+
If you are certain there is only one file that strongly matches, proceed with audit.
14+
15+
## Two-Phase Audit Process
16+
17+
### Phase 1: Quick Heuristics (try this first)
18+
19+
1. Read the note file
20+
2. Extract key terms, features, file paths, or function names mentioned
21+
3. Run simple checks:
22+
- Grep for key terms in the codebase
23+
- Glob for mentioned file paths
24+
- Check if described features/patterns exist
25+
4. Based on results, determine:
26+
- **IMPLEMENTED** - Key terms/files/patterns found in codebase
27+
- **INVALID** - Note contradicts current code or mentions non-existent paths
28+
- **UNCLEAR** - Heuristics inconclusive, need deeper analysis
29+
30+
### Phase 2: Deep Audit (only if Phase 1 returns UNCLEAR)
31+
32+
If heuristics fail, spawn a Task agent with this prompt:
33+
34+
```
35+
Read {filepath} and deeply analyze against the codebase.
36+
37+
Determine if the note is:
38+
- IMPLEMENTED: Feature/plan already exists in code
39+
- INVALID: Outdated, contradicts current implementation, or not applicable
40+
- VALID: Still relevant and could be worked on
41+
42+
Return:
43+
STATUS: [IMPLEMENTED|INVALID|VALID]
44+
EXPLANATION: [1-2 sentences why]
45+
```
46+
47+
## Output Format
48+
49+
Present results clearly:
50+
51+
```
52+
# Audit: {filename}
53+
54+
Status: [IMPLEMENTED|INVALID|VALID|UNCLEAR]
55+
56+
Explanation: [Brief explanation based on findings]
57+
58+
[If heuristics were used, show what was searched/found]
59+
[If deep audit was needed, show agent's analysis]
60+
```

0 commit comments

Comments
 (0)