vahidaskari
7bc34c79ed
- Removed all cloud-related functionalities, including login prompts and token handling. - Disabled Laxis cloud features, ensuring no data is sent to external servers. - Updated manifest to reflect the new local-only functionality. - Added a new Python server to handle transcripts locally, including WebSocket support. - Implemented storage management for transcripts, including deduplication and file writing. - Created a smoke test for the WebSocket server to simulate transcript updates. - Updated README with setup instructions and usage details for the new local server.
52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
# Action — Doc Writing
|
|
|
|
با قواعد اینجا باید اکشنها رو بسازی که داکهای من و خودت هست و بعد از اجرا اگر
|
|
جزییاتی داشت که من نیاز داشت بدونم توی ریزالت یک ریزالت با همین نام میسازی و
|
|
نتیجهی کارت رو داک میکنی.
|
|
اکشنها جنرال هستن و روی موقعیتهای مشابه ممکنه همون داک رو مجدد بهت بدم.
|
|
اما ریزالت میتونه داخلش اطلاعات اون اجرات و درسآموختههات باشه.
|
|
|
|
---
|
|
|
|
## ساختار فایلها
|
|
|
|
```
|
|
docs/
|
|
├── action/ ← عمومی، قابل استفاده مجدد
|
|
└── result/ ← مخصوص هر اجرا
|
|
```
|
|
|
|
**فرمت نام فایل:**
|
|
```
|
|
{sequential_numbering_xxx}_action_{short_title_of_doc}.md
|
|
{sequential_numbering_xxx}_result_{short_title_of_doc}.md
|
|
```
|
|
|
|
- شمارهی `NNN` بین جفت action/result **مشترک** است.
|
|
- عنوان کوتاه (`short_title`) در هر دو **یکسان** است.
|
|
|
|
---
|
|
|
|
## action چیست؟
|
|
|
|
- **جنرال** — هر بار که موقعیت مشابه پیش آمد، همین فایل داده میشود.
|
|
- **بدون جزئیات اجرا** — هیچ نام فایل، تاریخ، یا تصمیم مخصوص یک run توش نباشد.
|
|
- میتواند شامل: هدف، چکلیست کارها، قواعد، یا context کلی باشد.
|
|
- اگر در حین اجرا متوجه شدی که action ناقص یا گمراهکننده بوده، **آن را بهبود بده**.
|
|
|
|
## result چیست؟
|
|
|
|
- **مخصوص همان اجرا** — تاریخ، فایلهای ساختهشده، تصمیمهای گرفتهشده.
|
|
- **درسآموخته** — چیزی که دفعهی بعد باید متفاوت انجام شود.
|
|
- **وضعیت** — چه چیزی انجام شد، چه چیزی باقی ماند.
|
|
- **نیاز به تصمیم** — اگر چیزی هست که کاربر باید تصمیم بگیرد، اینجا بنویس.
|
|
|
|
---
|
|
|
|
## قواعد کلی
|
|
|
|
- result را **بعد از اجرا** بساز، نه قبل از آن.
|
|
- اگر result از قبل وجود داشت (اجرای مجدد همان action)، یا آپدیتش کن یا یک بخش
|
|
جدید با تاریخ جدید اضافه کن — فایل را overwrite نکن.
|
|
- اطلاعاتی که «کاربر نیاز دارد بداند» را در result بنویس، نه فقط خلاصهی فنی.
|