Skip to content

Commit a37e552

Browse files
AlexJSullyCopilot
andauthored
Update the audit-docs prompt (#571)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 69bed2b commit a37e552

4 files changed

Lines changed: 489 additions & 442 deletions

File tree

.github/prompts/audit-docs.prompt.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ labels:
1212

1313
## Role & Purpose
1414

15-
Act as a **Strictly Factual Technical Auditor**. Your goal is to ensure the `docs/` directory is an objective, verifiable reflection of the current implementation in the #codebase.
15+
Act as a **Strictly Factual Technical Writer and Auditor**. Your goal is to ensure the `docs/` directory is an objective, verifiable reflection of the current implementation in the #codebase.
16+
17+
**Your primary mandate is to write and correct documentation based on code reality.** Do not simply report on the state of documentation; perform the necessary updates to ensure the `docs/` directory perfectly matches the implementation found in the #codebase or #activePullRequest or #changes.
1618

1719
**Core Philosophy:**
1820

@@ -40,7 +42,15 @@ Execute **Phase 1** and **Phase 2** in order.
4042

4143
1. **Phase 1: PR Sync (Priority)**
4244
- **Condition:** If #activePullRequest or #changes exist.
43-
- **Action:** Update `docs/` to reflect _only_ the immediate changes introduced by the PR.
45+
- **Mandatory Interpretation:** This phase is a **documentation update step**, not a validation step.
46+
- **Action (Required):**
47+
- Treat the PR diff as the **source of truth**.
48+
- Identify **code-level changes introduced by the PR** (new behavior, removed behavior, modified behavior).
49+
- **Update `docs/` so that it accurately documents those changes**, even if:
50+
- The PR did not touch any documentation files.
51+
- Documentation already exists but is now incomplete or outdated.
52+
- Do **NOT** conclude Phase 1 is complete simply because docs were untouched.
53+
- **Scope Constraint:** Only document behavior that **changed as a direct result of the PR**.
4454
- **Next:** Proceed immediately to Phase 2.
4555

4656
2. **Phase 2: General Audit (Mandatory)**

.github/prompts/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This directory contains AI-powered prompt templates designed for **GitHub Copilot's coding agent** to automate code review, documentation auditing, and quality improvements. These prompts integrate seamlessly with Visual Studio Code (VSCode) and GitHub's pull request workflow.
44

5-
> [!CAUTION] ⚠️ CRITICAL: AI Accuracy Warning
5+
> [!CAUTION]
6+
> ⚠️ CRITICAL: AI Accuracy Warning
67
>
78
> **These prompts execute AI-driven code analysis and documentation generation. AI makes mistakes and hallucinations.** It is of utmost importance that you **carefully review all changes and output** before merging any PR. Do not blindly trust the AI's work. Verify that all suggested changes are:
89
>
@@ -107,7 +108,8 @@ targets:
107108

108109
## Important Safety Notes
109110

110-
> [!CAUTION] ⚠️ AI Makes Mistakes
111+
> [!CAUTION]
112+
> ⚠️ AI Makes Mistakes
111113
>
112114
> - **Hallucinations:** AI may invent function names, file paths, or code logic that don't exist
113115
> - **Inaccuracies:** AI may misinterpret complex code or miss edge cases

0 commit comments

Comments
 (0)