Skip to content

Commit b4fce36

Browse files
refine claude-code-doc-review.
1 parent 09b182c commit b4fce36

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

.github/workflows/claude-code-doc-review.yml

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,44 @@ jobs:
2525
github_token: ${{ secrets.GITHUB_TOKEN }}
2626
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
2727
prompt: |
28-
Review this PR and check if requirements/specs need updates.
28+
Review this PR and analyze impact on requirements and specifications documentation.
2929
3030
**Your task:**
3131
32-
1. Run git diff to see what changed
33-
2. Identify which modules changed (application, platform, wsi, etc.)
34-
3. Read relevant files from requirements/ and specifications/ directories
35-
4. Report which docs might need updates
32+
1. Run git diff to see what code changed
33+
2. Identify which modules were affected (application, platform, wsi, bucket, dataset, etc.)
34+
3. Read relevant files from:
35+
- requirements/ directory (SHR-*.md and SWR-*.md files)
36+
- specifications/ directory (SPEC-*.md files)
37+
4. Analyze if existing docs need updates OR if new docs need to be created
3638
37-
**Output format:**
39+
**IMPORTANT Rules:**
40+
- ONLY analyze files in requirements/ and specifications/ directories
41+
- SKIP template files like SPEC-MODULE-SERVICE-TEMPLATE.md
42+
- SKIP any other documentation outside these directories
43+
- If new documentation is needed, specify what file should be created following the existing naming pattern
44+
- Follow the same structure/format as existing files in those directories
3845
39-
## Changed Files
46+
**Post a PR comment with this format:**
47+
48+
## 📋 Requirements & Specifications Review
49+
50+
### Changed Code
4051
- List changed files
41-
- Identify affected modules
52+
- Affected modules: [list]
53+
54+
### 📝 Existing Docs to Update
55+
- `requirements/SHR-MODULE-X.md`: [1-sentence why it needs updating]
56+
- `specifications/SPEC-MODULE-SERVICE.md`: [1-sentence why it needs updating]
57+
58+
### ➕ New Docs Needed
59+
- **`requirements/SWR-MODULE-X-Y.md`**: [1-sentence describing what this new requirement should cover]
60+
- **`specifications/SPEC-NEWMODULE-SERVICE.md`**: [1-sentence describing what this new spec should cover]
4261
43-
## Requirements/Specs to Update
44-
- filename: 1-sentence why it needs updating
62+
### ✅ Docs Still Accurate
63+
- List requirements/specs that don't need changes
4564
46-
Keep it simple and concise.
65+
Keep it concise and actionable.
4766
claude_args: >-
4867
--max-turns 20
4968
--model claude-sonnet-4-5-20250929

0 commit comments

Comments
 (0)