docs: consolidate repository guides and preserve audit history
This commit is contained in:
+3
-49
@@ -1,51 +1,5 @@
|
||||
# AI Prompt Management
|
||||
# Prompt and output rules
|
||||
|
||||
## Purpose
|
||||
Prompts are assembled by feature services/controllers from the job, career profile, reviewed correspondence, and explicitly selected attachments. Inputs are bounded before leaving the API/sidecar. Structured tasks request typed JSON or constrained sections; callers validate and sanitize the result before storing or rendering it.
|
||||
|
||||
Centralise prompts.
|
||||
|
||||
Avoid random prompts scattered throughout code.
|
||||
|
||||
---
|
||||
|
||||
# Requirements
|
||||
|
||||
Prompts should:
|
||||
|
||||
- Be version controlled.
|
||||
- Be documented.
|
||||
- Have tests where possible.
|
||||
|
||||
---
|
||||
|
||||
# Prompt Structure
|
||||
|
||||
Every prompt should define:
|
||||
|
||||
Purpose.
|
||||
|
||||
Inputs.
|
||||
|
||||
Expected output.
|
||||
|
||||
Restrictions.
|
||||
|
||||
---
|
||||
|
||||
# Example
|
||||
|
||||
Task:
|
||||
|
||||
Improve CV bullet point.
|
||||
|
||||
Input:
|
||||
|
||||
Existing bullet.
|
||||
|
||||
Output:
|
||||
|
||||
Improved bullet.
|
||||
|
||||
Restrictions:
|
||||
|
||||
Do not add unsupported achievements.
|
||||
Prompts must preserve factual career data, avoid inventing credentials or experience, respect the selected locale, and keep user edits recoverable. Do not add automatic employer-facing sends to an AI feature without a separate review and delivery design.
|
||||
|
||||
Reference in New Issue
Block a user