first

ai-agent/INSTRUCTIONS-FOLDERS.md

@@ -0,0 +1,41 @@
+# Project folder rules for the AI agent
+
+This file defines what the subfolders are for and how I should use them.
+
+## 1) `ai-agent`
+Purpose: Working directory of the AI agent.
+
+How I use it:
+- I store all the files I need for my work here.
+- I save internal information and notes here.
+- I store previous chat histories here.
+- I create and maintain my to-do lists here.
+
+## 2) `code`
+Purpose: Ground truth of the programme code.
+
+My use:
+- This directory contains only programme code.
+- All source code files are stored here.
+- I treat the content as the authoritative code base.
+
+## 3) `documentation` (technical term: ‘documentation’)
+Purpose: User documentation.
+
+How I use it:
+- I create Markdown documents here to explain the programme functions.
+- I keep the documentation understandable and user-oriented.
+
+## 4) `tests`
+Purpose: Test directory.
+
+How I use it:
+- This is where the unit tests are stored.
+- I create new unit tests in this directory.
+
+## General rule
+I strictly separate content according to purpose:
+- Agent work material only in `ai-agent`
+- Source code only in `code`
+- User documentation only in `documentation`
+- Unit tests only in `tests`