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:
@@ -110,4 +110,17 @@ classDiagram
|
||||
|
||||
---
|
||||
|
||||
## ۷. استاندارد مستندات تحلیل (`docs/analysis/`)
|
||||
|
||||
همه فایلهای این پوشه باید ساختار یکسان داشته باشند:
|
||||
|
||||
- **سربرگ:** عنوان `#`، سپس `تهیهکننده`، `بازبین` و `آخرین بهروزرسانی` (تاریخ شمسی با ارقام فارسی)، و بعد خط `---`.
|
||||
- **بخشها:** بخش «مقدمه» بدون شماره؛ بخشهای اصلی با شماره (`## ۱.`)؛ آخرین بخش همیشه «نکات و پرسشهای باز» است.
|
||||
- **پایان:** خط `---` و سپس `**وضعیت سند:** ...`.
|
||||
- **شناسهها:** داستانها `US-NN`، نیازمندیهای کارکردی `FR-NN`، نیازمندیهای غیرکارکردی `NFR-NN`، نمودارها `AD-NN`.
|
||||
- **نام بازیگران:** فقط نام فارسی؛ دانشجو، استاد، کارمند تأسیسات، تعمیرکار، مدیر، کاربر سیستم. «گزارشدهنده» یعنی دانشجو یا استاد.
|
||||
- **ارجاع:** هر داستان فیلد «نیازمندیهای مرتبط» دارد و هر نمودار به داستانهای خود ارجاع میدهد.
|
||||
|
||||
---
|
||||
|
||||
اگر مرحلهای را متوجه نشدید، تو گروهمون بپرسید تا سریع حلش کنیم.
|
||||
|
||||
Reference in New Issue
Block a user