63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# Before Starting Any Work
|
|
- Please read the following documents carefully **before taking any actions** on this project: `README.md`, `Design_Doc/Spec.md`, `Design_Doc/Operations.md` and `Design_Doc/Tech_Desc.md`. You may skip the `Design_Doc/Tech_Desc.md` -> "AI Prompt" section and its sub-sections when reading. These files provide essential background information and project understanding. Only after reviewing them should you proceed with the following tasks.
|
|
|
|
# Your Current Tasks
|
|
- Listing the specific tasks for this session.
|
|
|
|
# Quick Reminder: Update the Documents After You Change the Code
|
|
|
|
Whenever you finish making code changes, please take a few minutes to update the related documents.
|
|
This keeps everything clear and up-to-date for everyone on the team.
|
|
|
|
## Which files might need an update?
|
|
Only touch the files that your changes actually affect. The most common ones are:
|
|
|
|
- `README.md`
|
|
- `Design_Doc/Spec.md`
|
|
- `Design_Doc/Operations.md`
|
|
- `Design_Doc/Tech_Desc.md`
|
|
|
|
## How should you update them?
|
|
Just follow the style and purpose each file already has.
|
|
(You can check the "Documentation Overview" part in `README.md` if you're not sure.)
|
|
|
|
---
|
|
|
|
## ⚠️ CRITICAL RULE for `Design_Doc/Tech_Desc.md` - The "AI Prompt" Section
|
|
|
|
**The "AI Prompt" section at the end of `Design_Doc/Tech_Desc.md` must NEVER be modified, deleted, or rewritten by you.**
|
|
|
|
### What is the "AI Prompt" section?
|
|
- It is the section that starts with `# AI Prompt` (level-1 heading)
|
|
- It is always located at the **very end** of `Design_Doc/Tech_Desc.md`
|
|
- It contains sub-sections like `## AI Prompt habit as a reminder`, `## Script Code`, `## Doc.`
|
|
- It contains **task history and instructions from previous sessions** written by the user
|
|
|
|
### Why must you NOT touch it?
|
|
- This section is **written and maintained by the user only**
|
|
- It contains **accumulated task history** that the user wants to preserve
|
|
- It is **not documentation** about the project - it is a **working log of tasks**
|
|
- Other team members (including the user) will update this section manually when needed
|
|
|
|
### What you MUST do:
|
|
✅ **Leave the "AI Prompt" section completely unchanged**
|
|
✅ **Keep the exact content** that is currently there (do not revert, do not update, do not clean up)
|
|
✅ **Only edit the technical documentation sections** that come BEFORE the "AI Prompt" section
|
|
✅ **Ensure "AI Prompt" stays at the end** of the file (do not move it)
|
|
|
|
### What you MUST NOT do:
|
|
❌ **Do NOT delete** the "AI Prompt" section
|
|
❌ **Do NOT modify** any words, sentences, or formatting inside "AI Prompt"
|
|
❌ **Do NOT revert** it to an older version
|
|
❌ **Do NOT clean up** or reorganize its content
|
|
❌ **Do NOT add** new task results to it (the user does this manually)
|
|
❌ **Do NOT remove** task history from it
|
|
|
|
### Simple rule to remember:
|
|
> **Everything before `# AI Prompt` = Your responsibility to update**
|
|
> **Everything from `# AI Prompt` to the end = User's responsibility, DO NOT TOUCH**
|
|
|
|
---
|
|
|
|
Thank you so much for helping keep the documents accurate and the task history preserved — it makes a big difference to the whole team!
|