From 801544951fbd44d5d3c32bafd160136c56c32bed Mon Sep 17 00:00:00 2001 From: Saky Date: Sun, 15 Mar 2026 18:26:22 +0100 Subject: [PATCH] docs: introduce mandatory AI logging system - add AI worklog and prompt logs - enforce logging rules in instructions-agent.md - require AI agents to record plan and build tasks - establish traceable AI-assisted development workflow --- docs/ai-prompts.md | 5 +++++ docs/ai-worklog.md | 9 +++++++++ instructions-agent.md | 45 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+) diff --git a/docs/ai-prompts.md b/docs/ai-prompts.md index 6335451..2b955cb 100644 --- a/docs/ai-prompts.md +++ b/docs/ai-prompts.md @@ -16,3 +16,8 @@ Store only the user prompt and a short result summary. - prompt summary: Implement a dedicated history mode in `src/app/ui.py` so pressing `h` hides the tree, shows only history entries, supports Up/Down navigation, and uses Enter to select a history entry and return to the normal tree view. - result summary: Added a dedicated history mode with its own selection state, removed the temporary overlay behavior, preserved existing `b`/`f` and normal tree navigation behavior, and added focused UI tests. + +## 2026-03-15 + +- prompt summary: Introduce a mandatory AI logging system by updating `instructions-agent.md` and adding repository logs for AI work entries and prompt summaries. +- result summary: Added enforceable AI logging rules to `instructions-agent.md`, created `docs/ai-worklog.md` and `docs/ai-prompts.md`, and established a traceable workflow for recording significant AI-assisted tasks. diff --git a/docs/ai-worklog.md b/docs/ai-worklog.md index 94a986c..5e58ef9 100644 --- a/docs/ai-worklog.md +++ b/docs/ai-worklog.md @@ -22,3 +22,12 @@ Entries must be concise and chronological. - validation: `make fix`, `make quality` - result: History mode now shows only the history list, supports Up/Down selection, allows Enter to jump to a prior directory, and exits cleanly back to normal navigation. - open issues: None. + +## 2026-03-15 - build + +- objective: Introduce mandatory AI logging rules and document the repository logging workflow. +- files modified: `instructions-agent.md`, `docs/ai-worklog.md`, `docs/ai-prompts.md` +- key decisions: Require AI agents to log significant plan and build tasks, preserve separate logs for work performed and prompts received, and keep entries concise and user-facing. +- validation: not run +- result: The repository now defines mandatory AI logging in `instructions-agent.md` and includes dedicated log files for AI work history and prompt summaries. +- open issues: None. diff --git a/instructions-agent.md b/instructions-agent.md index cfa0f42..64df783 100644 --- a/instructions-agent.md +++ b/instructions-agent.md @@ -83,3 +83,48 @@ Rules: 4. Do not store private chain-of-thought or internal reasoning. 5. Store only concise, user-facing summaries of what was done. 6. Keep entries chronological and easy to scan. + +## Mandatory AI Logging + +Every significant AI interaction in this repository must be logged. + +This applies to: +- `plan` tasks +- `build` tasks +- debugging tasks +- documentation tasks +- architectural discussions that affect the project + +Required files: +- `docs/ai-worklog.md` +- `docs/ai-prompts.md` + +Mandatory rules: +1. After every significant `plan` task, append a concise entry to `docs/ai-worklog.md`. +2. After every significant `build` task, append a concise entry to `docs/ai-worklog.md`. +3. If the task was driven by a meaningful prompt, also append an entry to `docs/ai-prompts.md`. +4. Logging is part of the task itself and must not be skipped. +5. The task is not complete until the logs are updated. + +Each worklog entry must include: +- date +- task type (`plan` or `build`) +- short objective +- files inspected or modified +- key decisions +- validation commands run, if any +- result +- unresolved issues, if any + +Each prompt log entry must include: +- date +- task type (`plan` or `build`) +- short prompt summary +- scope +- result summary + +Rules: +- Do not store chain-of-thought or private reasoning. +- Store only concise user-facing summaries. +- Keep entries chronological. +- Even small but meaningful tasks must be logged.