# README پروژه پژوهشی

الگوها را با رشته، شیوه‌نامه و شرایط واقعی پروژه خود تنظیم کنید.

## هدف و نسخه پروژه

هدف، نسخه و واقعی یا ساختگی بودن داده را صریح بنویسید.

تصمیم واقعی، دلیل و محل شاهد: ____________________

## منشأ داده و مجوز

منشأ، رضایت و مجوز داده و کد را جدا ثبت کنید.

تصمیم واقعی، دلیل و محل شاهد: ____________________

## محیط و وابستگی‌ها

نسخۀ واقعی سیستم و Python/بسته‌ها و نیاز اختیاری Quarto را مشخص کنید.

تصمیم واقعی، دلیل و محل شاهد: ____________________

## دستور اجرای مرتب

دستورها را از مسیر پروژه به ترتیب با ورودی/خروجی بنویسید؛ مسیر خصوصی را حذف کنید.

تصمیم واقعی، دلیل و محل شاهد: ____________________

## خروجی و کنترل‌ها

فایل انتظاررفته، آزمون با جواب معلوم و معیار شکست را شرح دهید؛ خروجی قدیمی بازاجرا نیست.

تصمیم واقعی، دلیل و محل شاهد: ____________________

## محدودیت و راه تماس

فرض‌ها، قابلیت انتقال محیط، محدودیت علمی و مسئول نگهداری را بنویسید.

تصمیم واقعی، دلیل و محل شاهد: ____________________

---

## مثال مرتبط و دفتر تصمیم

دفتر تصمیم و مثال آموزشی · 2026-10-06

مثال تکمیل‌شده فرضی است. اعداد و تصمیم‌ها نتیجۀ واقعی پژوهش نیستند؛ پرونده خود را با مجوز، روش و شیوه‌نامه مرتبط تکمیل کنید.

- پروژه: ____________________
- پژوهشگر و نقش: ____________________
- تاریخ و نسخه: ____________________
- داده‌ای که پیش از تصمیم دیده‌اید: ____________________
- هدف و دامنه: ____________________

## مثال تکمیل‌شده

| مرحله/تصمیم | مثال | کنترل یا اقدام |
| --- | --- | --- |
| ورودی | synthetic.csv با فرهنگ داده | فایل اصلی حفظ شده است؟ |
| کنترل | شناسه، نوع، حدود و پرچم کیفیت | خطای نامعتبر صریح متوقف می‌شود؟ |
| محاسبه | research.py از مسیر پروژه | هیچ مسیر شخصی مخفی ندارد؟ |
| خروجی | CSV، JSON، SVG و هش | با نسخۀ انتظاررفته تطبیق دارد؟ |
| دامنه | مثال آموزش، بدون استنباط علّی | محدودیت در README آمده است؟ |

## پروندۀ خود را تکمیل کنید

| موضوع | تصمیم واقعی و دلیل | پیوند شاهد و وضعیت |
| --- | --- | --- |
| ورودی | __________ | __________ |
| کنترل | __________ | __________ |
| محاسبه | __________ | __________ |
| خروجی | __________ | __________ |
| دامنه | __________ | __________ |

## معیار پایان کار

- [ ] بستۀ اجرای مستند و آزمون‌های با جواب معلوم را تحویل دهید.

## دفتر تغییر و محدودیت

| تاریخ | تغییر | شناخت داده در زمان تصمیم | دلیل | اثر بر ادعا | بازبین |
| --- | --- | --- | --- | --- | --- |
| __________ | __________ | __________ | __________ | __________ | __________ |

## منابع و مطالعه بیشتر

- [Python documentation](https://docs.python.org/3/)
- [JupyterLab — Notebooks](https://jupyterlab.readthedocs.io/en/stable/user/notebook.html)
- [Cornell Data Services — Writing READMEs for Research Data](https://data.research.cornell.edu/data-management/sharing/readme/)

راهنمای مرتبط: https://didgar-research-site1.vercel.app/fa/guides/research-programming/