mirror of
https://github.com/AmirAref/paya-university-fault-system.git
synced 2026-11-03 14:49:38 +00:00
Standardize analysis docs and add user story features (#25)
Align docs/analysis files on one structure: metadata header, unnumbered "مقدمه", numbered sections, and a final "نکات و پرسشهای باز" section. - user-story.md: add "نیازمندیهای مرتبط" (FR refs) to each US, number the sections, and update the last-updated date - requirements-specification.md: define "گزارشدهنده" and align the closing section name - activity.md: add metadata header and مقدمه, drop English actor labels, give each diagram an AD-NN id, and add a status line - CONTRIBUTING.md: record the analysis docs standard as section ۷ - features/: Gherkin scenarios for US-01, US-05 and US-15
This commit is contained in:
+167
-131
@@ -1,131 +1,167 @@
|
||||
# داستانهای کاربر (User Stories) – سامانه مدیریت و گزارش خرابی دانشگاهی
|
||||
|
||||
**تهیهکننده:** امیرحسن عارف اصل
|
||||
**بازبین:** ارشیا همتیزاده
|
||||
**آخرین بهروزرسانی:** ۱۴۰۴/۰۸/۰۴
|
||||
|
||||
---
|
||||
|
||||
## مقدمه
|
||||
|
||||
در این سند، نیازمندیهای اصلی سامانه به صورت **داستان کاربر (User Story)** نوشته شدهاند.
|
||||
هر داستان کاربر از دیدگاه یک نقش مشخص بیان میشود و هدف آن را نیز مشخص میکند.
|
||||
|
||||
قالب استاندارد:
|
||||
|
||||
> به عنوان یک **<نقش>**
|
||||
> میخواهم **<هدف>**
|
||||
> تا بتوانم **<مزیت / نتیجه>**
|
||||
|
||||
---
|
||||
|
||||
## داستانهای کاربر مرتبط با گزارشدهنده (دانشجو / استاد)
|
||||
|
||||
### US-01
|
||||
به عنوان یک **دانشجو**
|
||||
میخواهم **خرابی مشاهدهشده را به همراه مکان و توضیحات ثبت کنم**
|
||||
تا بتوانم **مشکل را سریع به بخش تأسیسات اطلاع دهم و پیگیری کنم**.
|
||||
|
||||
### US-02
|
||||
به عنوان یک **استاد**
|
||||
میخواهم **خرابی کلاس یا آزمایشگاه را ثبت کنم**
|
||||
تا بتوانم **بدون اتلاف وقت، مشکل را به مسئولان مربوطه اعلام کنم**.
|
||||
|
||||
### US-03
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **وضعیت گزارشهایی که خودم ثبت کردهام را مشاهده کنم**
|
||||
تا بتوانم **از پیشرفت رسیدگی به گزارشم مطلع شوم**.
|
||||
|
||||
### US-04
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **تصویر یا توضیح بیشتری به گزارش قبلی اضافه کنم**
|
||||
تا بتوانم **اطلاعات کاملتری در اختیار تعمیرکار قرار دهم**.
|
||||
|
||||
### US-05
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **پس از اعلام رفع خرابی، آن را تأیید یا رد کنم**
|
||||
تا بتوانم **از بسته شدن صحیح گزارش مطمئن شوم**.
|
||||
|
||||
---
|
||||
|
||||
## داستانهای کاربر مرتبط با کارمند تأسیسات
|
||||
|
||||
### US-06
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **لیست تمام گزارشهای باز را مشاهده و فیلتر کنم**
|
||||
تا بتوانم **گزارشهای مهم و فوری را سریعتر پیدا کنم**.
|
||||
|
||||
### US-07
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **اولویت هر گزارش را تعیین کنم**
|
||||
تا بتوانم **تعمیرات را بر اساس اهمیت و فوریت مدیریت کنم**.
|
||||
|
||||
### US-08
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **یک گزارش را به تعمیرکار مناسب تخصیص دهم**
|
||||
تا بتوانم **کار را به فرد درست ارجاع دهم و پیگیری کنم**.
|
||||
|
||||
### US-09
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **وضعیت گزارش را تغییر دهم**
|
||||
تا بتوانم **وضعیت واقعی رسیدگی به هر گزارش را در سیستم منعکس کنم**.
|
||||
|
||||
### US-10
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **تاریخچه کامل اقدامات انجامشده روی یک گزارش را ببینم**
|
||||
تا بتوانم **روند رسیدگی را بررسی و در صورت نیاز پیگیری کنم**.
|
||||
|
||||
---
|
||||
|
||||
## داستانهای کاربر مرتبط با تعمیرکار
|
||||
|
||||
### US-11
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **لیست کارهای تخصیصیافته به خودم را ببینم**
|
||||
تا بتوانم **بدانم چه کارهایی در انتظار انجام است**.
|
||||
|
||||
### US-12
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **شروع کار روی یک گزارش را اعلام کنم**
|
||||
تا بتوانم **وضعیت گزارش را به «در حال تعمیر» تغییر دهم**.
|
||||
|
||||
### US-13
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **نتیجه تعمیر را همراه با توضیحات ثبت کنم**
|
||||
تا بتوانم **گزارش را به مرحله بعدی (تأیید یا پیگیری) برسانم**.
|
||||
|
||||
### US-14
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **در صورت نیاز، اطلاعات بیشتری از گزارشدهنده درخواست کنم**
|
||||
تا بتوانم **تعمیر را با اطلاعات کاملتری انجام دهم**.
|
||||
|
||||
---
|
||||
|
||||
## داستانهای کاربر مشترک / سیستمی
|
||||
|
||||
### US-15
|
||||
به عنوان یک **کاربر سیستم**
|
||||
میخواهم **با نام کاربری و رمز عبور وارد سامانه شوم**
|
||||
تا بتوانم **به امکانات مربوط به نقش خودم دسترسی داشته باشم**.
|
||||
|
||||
### US-16
|
||||
به عنوان یک **کاربر سیستم**
|
||||
میخواهم **هنگام تغییر وضعیت گزارش مرتبط با خودم، اعلان دریافت کنم**
|
||||
تا بتوانم **از آخرین وضعیت مطلع شوم**.
|
||||
|
||||
### US-17
|
||||
به عنوان یک **کارمند تأسیسات یا مدیر**
|
||||
میخواهم **داشبورد خلاصهای از تعداد گزارشهای باز و فوری ببینم**
|
||||
تا بتوانم **وضعیت کلی خرابیها را سریع ارزیابی کنم**.
|
||||
|
||||
---
|
||||
|
||||
## نکات و کارهای باقیمانده
|
||||
|
||||
- این داستانها نسخه اولیه هستند و ممکن است در بازبینی تغییر کنند یا داستانهای جدید اضافه شود.
|
||||
- جزئیات پذیرش (Acceptance Criteria) برای داستانهای مهمتر در مراحل بعدی نوشته خواهد شد.
|
||||
- ابهام دامنه (آیا خوابگاهها و فضاهای اداری هم شامل میشوند؟) هنوز وجود دارد و روی برخی داستانها تأثیر میگذارد.
|
||||
|
||||
---
|
||||
|
||||
**وضعیت سند:** نسخه اولیه (Draft) – آماده بازبینی
|
||||
# داستانهای کاربر (User Stories) – سامانه مدیریت و گزارش خرابی دانشگاهی
|
||||
|
||||
**تهیهکننده:** امیرحسن عارف اصل
|
||||
**بازبین:** ارشیا همتیزاده
|
||||
**آخرین بهروزرسانی:** ۱۴۰۵/۰۸/۱۱
|
||||
|
||||
---
|
||||
|
||||
## مقدمه
|
||||
|
||||
در این سند، نیازمندیهای اصلی سامانه به صورت **داستان کاربر (User Story)** نوشته شدهاند.
|
||||
هر داستان کاربر از دیدگاه یک نقش مشخص بیان میشود و هدف آن را نیز مشخص میکند.
|
||||
معیارهای پذیرش (Acceptance Criteria) هر داستان در Issue متناظر آن در GitHub ثبت شدهاند.
|
||||
|
||||
قالب استاندارد:
|
||||
|
||||
> به عنوان یک **<نقش>**
|
||||
> میخواهم **<هدف>**
|
||||
> تا بتوانم **<مزیت / نتیجه>**
|
||||
|
||||
---
|
||||
|
||||
## ۱. داستانهای کاربر مرتبط با گزارشدهنده (دانشجو / استاد)
|
||||
|
||||
### US-01
|
||||
به عنوان یک **دانشجو**
|
||||
میخواهم **خرابی مشاهدهشده را به همراه مکان و توضیحات ثبت کنم**
|
||||
تا بتوانم **مشکل را سریع به بخش تأسیسات اطلاع دهم و پیگیری کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-03، FR-05
|
||||
|
||||
### US-02
|
||||
به عنوان یک **استاد**
|
||||
میخواهم **خرابی کلاس یا آزمایشگاه را ثبت کنم**
|
||||
تا بتوانم **بدون اتلاف وقت، مشکل را به مسئولان مربوطه اعلام کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-03
|
||||
|
||||
### US-03
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **وضعیت گزارشهایی که خودم ثبت کردهام را مشاهده کنم**
|
||||
تا بتوانم **از پیشرفت رسیدگی به گزارشم مطلع شوم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-05، FR-16
|
||||
|
||||
### US-04
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **تصویر یا توضیح بیشتری به گزارش قبلی اضافه کنم**
|
||||
تا بتوانم **اطلاعات کاملتری در اختیار تعمیرکار قرار دهم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-04
|
||||
|
||||
### US-05
|
||||
به عنوان یک **دانشجو یا استاد**
|
||||
میخواهم **پس از اعلام رفع خرابی، آن را تأیید یا رد کنم**
|
||||
تا بتوانم **از بسته شدن صحیح گزارش مطمئن شوم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-14
|
||||
|
||||
---
|
||||
|
||||
## ۲. داستانهای کاربر مرتبط با کارمند تأسیسات
|
||||
|
||||
### US-06
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **لیست تمام گزارشهای باز را مشاهده و فیلتر کنم**
|
||||
تا بتوانم **گزارشهای مهم و فوری را سریعتر پیدا کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-06، FR-08
|
||||
|
||||
### US-07
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **اولویت هر گزارش را تعیین کنم**
|
||||
تا بتوانم **تعمیرات را بر اساس اهمیت و فوریت مدیریت کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-07
|
||||
|
||||
### US-08
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **یک گزارش را به تعمیرکار مناسب تخصیص دهم**
|
||||
تا بتوانم **کار را به فرد درست ارجاع دهم و پیگیری کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-09
|
||||
|
||||
### US-09
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **وضعیت گزارش را تغییر دهم**
|
||||
تا بتوانم **وضعیت واقعی رسیدگی به هر گزارش را در سیستم منعکس کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-11
|
||||
|
||||
### US-10
|
||||
به عنوان یک **کارمند تأسیسات**
|
||||
میخواهم **تاریخچه کامل اقدامات انجامشده روی یک گزارش را ببینم**
|
||||
تا بتوانم **روند رسیدگی را بررسی و در صورت نیاز پیگیری کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-16
|
||||
|
||||
---
|
||||
|
||||
## ۳. داستانهای کاربر مرتبط با تعمیرکار
|
||||
|
||||
### US-11
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **لیست کارهای تخصیصیافته به خودم را ببینم**
|
||||
تا بتوانم **بدانم چه کارهایی در انتظار انجام است**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-10
|
||||
|
||||
### US-12
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **شروع کار روی یک گزارش را اعلام کنم**
|
||||
تا بتوانم **وضعیت گزارش را به «در حال تعمیر» تغییر دهم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-11
|
||||
|
||||
### US-13
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **نتیجه تعمیر را همراه با توضیحات ثبت کنم**
|
||||
تا بتوانم **گزارش را به مرحله بعدی (تأیید یا پیگیری) برسانم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-12
|
||||
|
||||
### US-14
|
||||
به عنوان یک **تعمیرکار**
|
||||
میخواهم **در صورت نیاز، اطلاعات بیشتری از گزارشدهنده درخواست کنم**
|
||||
تا بتوانم **تعمیر را با اطلاعات کاملتری انجام دهم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-13
|
||||
|
||||
---
|
||||
|
||||
## ۴. داستانهای کاربر مشترک / سیستمی
|
||||
|
||||
### US-15
|
||||
به عنوان یک **کاربر سیستم**
|
||||
میخواهم **با نام کاربری و رمز عبور وارد سامانه شوم**
|
||||
تا بتوانم **به امکانات مربوط به نقش خودم دسترسی داشته باشم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-01، FR-02
|
||||
|
||||
### US-16
|
||||
به عنوان یک **کاربر سیستم**
|
||||
میخواهم **هنگام تغییر وضعیت گزارش مرتبط با خودم، اعلان دریافت کنم**
|
||||
تا بتوانم **از آخرین وضعیت مطلع شوم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-15
|
||||
|
||||
### US-17
|
||||
به عنوان یک **کارمند تأسیسات یا مدیر**
|
||||
میخواهم **داشبورد خلاصهای از تعداد گزارشهای باز و فوری ببینم**
|
||||
تا بتوانم **وضعیت کلی خرابیها را سریع ارزیابی کنم**.
|
||||
|
||||
**نیازمندیهای مرتبط:** FR-17
|
||||
|
||||
---
|
||||
|
||||
## ۵. نکات و پرسشهای باز
|
||||
|
||||
- این داستانها نسخه اولیه هستند و ممکن است در بازبینی تغییر کنند یا داستانهای جدید اضافه شود.
|
||||
- معیارهای پذیرش هر داستان در Issue متناظر آن در GitHub ثبت شدهاند. در مواردی که نیازمندیها هنوز مشخص نیستند، فرضهای موقت در همان Issue علامتگذاری شدهاند.
|
||||
- ابهام دامنه (آیا خوابگاهها و فضاهای اداری هم شامل میشوند؟) هنوز وجود دارد و روی برخی داستانها تأثیر میگذارد.
|
||||
- پرسشهای باز دیگر (اولویتها، وضعیتها، اعلانها و ...) در بخش «نکات و پرسشهای باز» [نمودارهای فعالیت](activity.md) فهرست شدهاند.
|
||||
|
||||
---
|
||||
|
||||
**وضعیت سند:** نسخه اولیه (Draft) – آماده بازبینی
|
||||
|
||||
Reference in New Issue
Block a user