Saky
d9d412973b
- align instructions, workflow rules, and task template with three-level logging - extend ai-task generation to support execution-log requirements - update worklog, prompt log, and execution log for the finalized framework - validate the framework with generator and project quality checks
180 lines
3.1 KiB
Markdown
180 lines
3.1 KiB
Markdown
# AI Task Template
|
|
|
|
Reusable prompt template for launching tasks with AI agents.
|
|
|
|
This template enforces the repository workflow defined in:
|
|
|
|
- AGENT.md
|
|
- AGENT_WORKFLOW.md
|
|
- instructions-agent.md
|
|
|
|
It ensures every task follows the deterministic sequence:
|
|
|
|
PLAN → REVIEW → BUILD → VALIDATE → LOG
|
|
|
|
---
|
|
|
|
# Basic Task Structure
|
|
|
|
Use the following structure when requesting work from an AI agent.
|
|
|
|
```
|
|
Task Type:
|
|
PLAN | BUILD
|
|
|
|
Task ID:
|
|
PLAN-YYYYMMDD-XXX | BUILD-YYYYMMDD-XXX
|
|
|
|
Date:
|
|
YYYY-MM-DD HH:MM
|
|
|
|
Objective:
|
|
Short description of the goal.
|
|
|
|
Context:
|
|
Relevant background about the current repository state.
|
|
|
|
Scope:
|
|
List of files or directories the agent may modify or inspect.
|
|
|
|
Requirements:
|
|
Detailed description of the behavior that must be implemented or analyzed.
|
|
|
|
Constraints:
|
|
Things the agent must NOT change or must preserve.
|
|
|
|
Testing:
|
|
Describe expected tests or validations.
|
|
|
|
Validation:
|
|
The agent must run:
|
|
|
|
make fix
|
|
make quality
|
|
|
|
Logging requirements:
|
|
- Append an entry to docs/ai-worklog.md
|
|
- Append an entry to docs/ai-prompts.md
|
|
- Append an entry to docs/ai-execution-log.md
|
|
- Include Date, Task ID, Agent, Scope, Result
|
|
|
|
Execution Logging requirements:
|
|
- Append an entry to docs/ai-execution-log.md
|
|
- Include:
|
|
- full prompt
|
|
- agent todos
|
|
- final execution report
|
|
- Use the standard execution log format defined in docs/ai-execution-log.md
|
|
|
|
Git requirements:
|
|
- Do NOT commit or push unless explicitly requested.
|
|
|
|
Expected Report:
|
|
The agent must summarize:
|
|
- files changed
|
|
- behavior changes
|
|
- validation results
|
|
```
|
|
|
|
---
|
|
|
|
# Example BUILD Task
|
|
|
|
```
|
|
Task Type:
|
|
BUILD
|
|
|
|
Task ID:
|
|
BUILD-YYYYMMDD-XXX
|
|
|
|
Date:
|
|
YYYY-MM-DD HH:MM
|
|
|
|
Objective:
|
|
Improve vertical scrolling behavior in the terminal UI.
|
|
|
|
Scope:
|
|
- src/app/ui.py
|
|
- tests/test_ui.py
|
|
|
|
Requirements:
|
|
Ensure the selected entry remains visible when navigating through long directory lists.
|
|
|
|
Constraints:
|
|
Do not modify navigator logic.
|
|
|
|
Testing:
|
|
Add helper tests if necessary.
|
|
|
|
Validation:
|
|
make fix
|
|
make quality
|
|
|
|
Logging requirements:
|
|
- Update `docs/ai-worklog.md` and `docs/ai-prompts.md` using the standard log format.
|
|
|
|
Execution Logging requirements:
|
|
- Update docs/ai-execution-log.md with:
|
|
- full prompt
|
|
- agent todos
|
|
- final execution report
|
|
|
|
Git requirements:
|
|
- Do NOT commit or push unless explicitly requested.
|
|
```
|
|
|
|
---
|
|
|
|
# Example PLAN Task
|
|
|
|
```
|
|
Task Type:
|
|
PLAN
|
|
|
|
Task ID:
|
|
PLAN-YYYYMMDD-XXX
|
|
|
|
Date:
|
|
YYYY-MM-DD HH:MM
|
|
|
|
Objective:
|
|
Investigate inconsistent navigation behavior.
|
|
|
|
Scope:
|
|
- src/app/ui.py
|
|
- src/app/navigator.py
|
|
|
|
Requirements:
|
|
Analyze the current navigation flow and propose a minimal fix.
|
|
|
|
Constraints:
|
|
Do not modify code.
|
|
|
|
Validation:
|
|
make fix
|
|
make quality
|
|
|
|
Logging requirements:
|
|
- Update `docs/ai-worklog.md` and `docs/ai-prompts.md` using the standard log format.
|
|
|
|
Execution Logging requirements:
|
|
- Update docs/ai-execution-log.md with:
|
|
- full prompt
|
|
- agent todos
|
|
- final execution report
|
|
|
|
Git requirements:
|
|
- Do NOT commit or push unless explicitly requested.
|
|
|
|
Expected Output:
|
|
- diagnosis summary
|
|
- proposed changes
|
|
- expected file scope
|
|
```
|
|
|
|
---
|
|
|
|
# Notes
|
|
|
|
This template keeps AI interactions consistent across tasks and helps maintain a clean development history.
|