این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- INCF
- نویسنده فنی:
- hq
- نام پروژه:
- اسناد آموزشی LORIS برای علوم اعصاب قابل تکرار باز
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
I. چکیده
سیستم تحقیقات و تصویربرداری آنلاین طولی (LORIS) یک پلت فرم مدیریت پروژه روی وب برای تحقیقات تصویربرداری عصبی است که از چندین طرح علوم باز پشتیبانی می کند. اسناد نقش مهمی در LORIS ایفا می کند. به طور خاص، اسناد به کاربران و توسعه‌دهندگان LORIS کمک می‌کند تا جزئیات نرم‌افزار را درک کنند تا بهتر از پلتفرم استفاده کنند یا در توسعه نرم‌افزار مشارکت داشته باشند. در همین حال، اسناد LORIS نیز باید به روز شود. هدف این پروژه کمک به LORIS برای بهبود مستنداتش است.
II. وضعیت فعلی
LORIS در حال حاضر از Github Wiki، Read the Docs و وب سایت LORIS.ca برای میزبانی تمام اسناد استفاده می کند. به طور خاص، LORIS GitHub Wiki میزبان بیشترین مقدار اسناد LORIS است و آموزش‌های LORIS، ارائه‌ها، راهنمای کاربر و راهنماهای راهنما در پلتفرم‌های مختلف میزبانی می‌شوند. اسناد LORIS فعلی راهنماهایی را برای توسعه دهندگان و کاربران LORIS ارائه می دهد، اما می تواند از توسعه و سازماندهی بیشتر، به ویژه در به روز رسانی اسناد و بهبود جزئیات فنی بهره مند شود.
III. منافع برای جامعه
با بهبود اسناد آموزشی LORIS برای علوم اعصاب بازتولیدپذیر، محققان و توسعه دهندگان از ابزار کاربر پسندتری برای بهبود جمع آوری داده ها در مطالعات خود بهره مند خواهند شد. به طور خاص، این پروژه ممکن است اسناد نصب/راه اندازی LORIS و همچنین مواد کاربر نهایی را که برای کاربران جدید آموزش می دهد، به روز کرده و بهبود بخشد. علاوه بر این، هدف این پروژه کمک به مهاجرت و به روز رسانی اسناد از ویکی LORIS GitHub به Read the Docs خواهد بود. در همین حال، پروژه ممکن است یک نمودار پایگاه داده برای برقراری ارتباط روابط داده و بهبود تجسم معماری ارائه دهد. در نهایت، این پروژه محتوایی را به‌روزرسانی و بهبود می‌بخشد که مردم را با LORIS، زمینه علمی باز و موارد استفاده از آن آشنا می‌کند.
IV. نقاط قوت شخصی برای پروژه
در چند سال گذشته، من در چندین پروژه فنی شرکت کرده ام که از طریق آنها پیشینه قوی در نویسندگی فنی ایجاد کرده ام. به طور خاص، من مسئولیت نوشتن اسناد در چندین پروژه تیمی گذشته را بر عهده داشتم و معتقدم تجربه کافی در استفاده از ابزارهای نوشتاری فنی مانند Read the Docs، Sphinx، Mkdocs، markdown، LaTeX و غیره را دارم. در همین حال، سابقه تدریس قبلی در دوره های STEM همچنین مهارت های من را در ارتباطات فنی بهبود بخشیده است. اسناد آموزشی LORIS برای پروژه های بازتولیدپذیر علوم اعصاب با INCF فرصتی عالی برای من خواهد بود تا تکنیک های نگارش فنی خود را در LORIS اعمال کنم. علاوه بر این، من علاقه زیادی به رشته تصویربرداری عصبی دارم و سعی کرده ام فرصت هایی را پیدا کنم تا دانش فنی خود را در این زمینه به کار ببرم. اسناد آموزشی LORIS برای پروژه های بازتولیدپذیر علوم اعصاب با INCF برای من تجربه ارزشمندی خواهد بود.
V. قابل تحویل
- مهاجرت و به روز رسانی اسناد LORIS فعلی
- اسناد نصب/راه اندازی LORIS را بازبینی، به روز رسانی و بهبود بخشید و شکاف های موجود در مواد کاربر نهایی را پر کنید که برای کاربران جدید آموزش می دهد.
- به ایجاد یک نمودار پایگاه داده برای برقراری ارتباط با روابط داده ها (به عنوان مثال موضوع، بازدید مطالعه) و بهبود تجسم معماری کمک کنید
- به به روز رسانی و بهبود اسناد LORIS API کمک کنید
- کمک به به روز رسانی و بهبود محتوایی که افراد را با LORIS، زمینه علمی باز آن، و موارد استفاده از آن، شامل قالب های رسانه ای متعدد، آشنا می کند.
VI. جدول زمانی
Community Bonding (17 آگوست - 13 سپتامبر) الف) آشنایی کامل با نرم افزار LORIS و گردش کار تیم. ب) اسناد نصب/راه اندازی LORIS را بررسی، به روز رسانی و بهبود بخشید.
هفته 1 (14 سپتامبر - 20 سپتامبر) اسناد LORIS را از ویکی GitHub به Read the Docs به‌روزرسانی و انتقال دهید.
هفته 2 (21 سپتامبر - 27 سپتامبر) الف) مطالب فعلی کاربر نهایی LORIS را مرور کنید. ب) شروع به پر کردن شکاف های موجود در مواد کاربر نهایی LORIS که بر اساس اسناد فعلی آموزش برای کاربران جدید ارائه می دهد.
هفته 3 (28 سپتامبر - 4 اکتبر) با پر کردن مواد کاربر نهایی LORIS که برای کاربران جدید آموزش فراهم می کند، شکاف ها را تکمیل کنید.
هفته 4 (5 اکتبر - 11 اکتبر) الف) معماری فعلی پایگاه داده LORIS را درک کنید. ب) شروع به پیاده سازی نمودار پایگاه داده برای پلت فرم LORIS کنید.
هفته 5 (12 اکتبر - 18 اکتبر) الف) کار تولید نمودار پایگاه داده LORIS را تمام کنید. ب) API LORIS فعلی را مرور کنید و شروع به کمک به بهبود اسناد API کنید.
هفته 6 (19 اکتبر - 25 اکتبر) به کار بر روی بهبود اسناد LORIS API ادامه دهید.
هفته 7 (26 اکتبر - 1 نوامبر) بهبود اسناد API LORIS را به پایان برسانید.
هفته 8 (2 نوامبر - 8 نوامبر) محتوای فعلی را مرور کنید که افراد را با LORIS آشنا می کند و شروع به به روز رسانی و بهبود زمینه علمی باز کنید.
هفته 9 (9 نوامبر - 15 نوامبر) به روز رسانی ها و بهبود زمینه های علمی باز در محتوای معرفی افراد به LORIS را به پایان برسانید.
هفته 10 (16 نوامبر - 22 نوامبر) به به روز رسانی و بهبود بخشی از موارد استفاده در محتوای معرفی افراد به LORIS کمک کنید.
هفته 11 (23 نوامبر - 29 نوامبر) به روز رسانی و بهبود همه موارد استفاده را در مطالبی که افراد را با LORIS آشنا می کند، به پایان برسانید.
نهایی کردن پروژه (30 نوامبر - 5 دسامبر) الف) تمام اسنادی را که من ایجاد کردم پاک کنید. ب) همه درخواست‌های کششی ایجاد شده را در GitHub ادغام کنید و تمام مسائلی را که ایجاد کردم ببندید. ج) گزارش نهایی پروژه ام را تمام کنید و گزارش را به گوگل ارسال کنید.
VII. محصولات تحویلی آینده
پس از فصل Google Docs 2020، می‌خواهم به مشارکت‌هایم در اسناد LORIS ادامه دهم. به طور خاص، من می خواهم با توسعه دهندگان LORIS در مورد امکان ادامه به روز رسانی و ایجاد اسناد برای نسخه های جدید بحث کنم. علاوه بر این، می‌خواهم برای بررسی اسنادی که در طول پروژه فصل Google Docs خود ایجاد کرده‌ام، زمان بیشتری صرف کنم و بررسی کنم که آیا فضای بیشتری برای بهبود وجود دارد یا خیر. در نهایت، از آنجایی که من پیشینه مهندسی مرتبط دارم، می‌خواهم در آینده در سایر جنبه‌های نرم‌افزار LORIS، به عنوان مثال، توسعه نرم‌افزار مشارکت کنم.