این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- OpenMRS
- نویسنده فنی:
- رنگین کمان
- نام پروژه:
- بهبود اسناد فنی OpenMRS برای توسعه دهندگان جدید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
منطق
از آنجایی که جهان از پیامدهای همه‌گیری COVID-19 رنج می‌برد، حتی واضح‌تر است که یک سیستم سوابق پزشکی منبع باز مانند OpenMRS می‌تواند بخشی از راه‌حل این نوع بحران باشد. برای کمک به توسعه دهندگان جدید در جهت یابی اکوسیستم OpenMRS، کوتاه کردن فرآیند نصب آنها و اجازه دادن به تازه واردان بیشتر برای کمک به توسعه OpenMRS، داشتن اسناد مختصر، واضح و به روز ضروری است. دو سند موجود برای توسعه دهندگان جدید وجود دارد: • شروع به کار به عنوان یک توسعه دهنده • راهنمای برنامه نویس با این حال، برخی از محتویات قدیمی هستند و قالب نیاز به بهبود دارد. هدف از این پروژه به روز رسانی محتوا و بهبود فرمت این دو سند برای کاربرپسندتر کردن آنهاست.
دامنه
- محتوای این دو سند را دوباره سازماندهی و قالب بندی کنید. برای شروع به عنوان یک سند توسعه دهنده: الف. 17 مرحله دستورالعمل را به بخش ها تقسیم کنید، هر بخش شامل مراحل کمتری است، به طوری که دنبال کردن آن برای کاربر آسان تر است. ب ترتیب مراحل را دوباره ترتیب دهید. برخی از مراحل را می توان ترکیب کرد. ج. پیوندهای سایر صفحات ویکی را در جداول فهرست کنید تا دستورالعمل ها مختصرتر و خواناتر باشند.
برای کتابچه راهنمای توسعه دهنده: الف. اطلاعات پس زمینه OpenMRS در چند فصل اول را می توان کوتاه کرد، کاربران می توانند به صفحه OpenMRS.org هدایت شوند تا جزئیات بیشتری را بیابند. ب فصل راه اندازی باید قبل از فصل فرآیند توسعه به بالا منتقل شود
مطالب را به روز کنید. برای شروع به عنوان یک سند توسعه دهنده: الف. به روز رسانی محیط تنظیم شده برای لینوکس و ویندوز (معرفی Docker) ب. پیکربندی IDE را برای IntelliJ و Eclipse c به روز کنید. هر جا که لازم است به کتابچه راهنمای برنامه‌نویس یا راهنمای برنامه‌نویس پیوند دهید. د مطمئن شوید که تمام محتوای پیوند به به روز هستند.
برای کتابچه راهنمای توسعه دهنده: الف. گردش کار توسعه را معرفی کنید. ب نحوه سازماندهی تیم های توسعه، نحوه همکاری اعضای تیم با یکدیگر را معرفی کنید. اضافه کردن لینک به جلسه تیم، بحث های تیمی. به توسعه دهندگان جدید کمک کنید تا تیم هایی را که ممکن است بخواهند به آنها ملحق شوند پیدا کنند. ج. اضافه کردن Docker در بخش تنظیمات سیستم. د جزئیات بیشتری در مورد انواع مختلف ماژول ها (ماژول برنامه مرجع، ماژول OWA و ماژول پلت فرم)، نحوه کار آنها با یکدیگر اضافه کنید. ه. کدهای نمونه ساده را اضافه کنید تا نشان دهید که هر نوع ماژول چگونه ساخته و مستقر می شود. f. برای هر نوع ماژول نمونه های آزمایشی ساده اضافه کنید.
تحلیل مخاطب
مخاطبان در نظر گرفته شده برای شروع به‌عنوان یک توسعه‌دهنده و کتابچه راهنمای توسعه‌دهنده، توسعه‌دهندگانی هستند که اطلاعات کمی از OpenMRS دارند یا اصلاً دانش ندارند. دو نوع توسعه‌دهنده می‌تواند وجود داشته باشد: اولین نوع مخاطب، توسعه‌دهندگان جوانی هستند که تجربه توسعه نرم‌افزاری کمی دارند یا اصلاً تجربه ندارند. به عنوان مثال، دانش آموزان GSoC، که به دنبال پروژه های دنیای واقعی برای یادگیری در مورد توسعه نرم افزار منبع باز هستند. برای این توسعه دهندگان، این دو سند باید جزئیات و منابع کافی را ارائه دهند تا بتوانند شکاف های دانش را پر کنند و در مدت زمان نسبتاً کوتاهی شروع به مشارکت در پروژه های OpenMRS کنند. اهداف اصلی برای توسعه دهندگان جوان عبارتند از: 1. درک مهارت های مورد نیاز برای شرکت در OpenMRS (MySQL، Java Spring. React.js، Git و غیره) و یافتن منابع برای یادگیری این مهارت ها. 2. به جامعه OpenMRS بپیوندید، ابزارهای ارتباطی را بیاموزید. 3. محیط و IDE را تنظیم کنید. 4. OpenMRS SDK را نصب کنید. 5. گردش کار توسعه را درک کنید. 6. کدهای ساده برای ایجاد ماژول های جدید تولید کنید. 7. ماژول های جدید ایجاد شده را مستقر کنید. 8. ماژول های تست. 9. از Git برای درخواست کشش استفاده کنید. نوع دوم از مخاطبان، توسعه دهندگان سطح متوسط یا توسعه دهندگان ارشد هستند که به دنبال شخصی سازی OpenMRS برای مطابقت با نیازهای سازمان خود یا مشارکت در OpenMRS هستند. برای این توسعه دهندگان با تجربه تر، این دو سند باید یک نمای کلی از OpenMRS ارائه دهند و به عنوان راهنمایی برای هدایت آنها به جزئیات بیشتر فناوری در راهنمای توسعه دهنده و سایر منابع عمل کنند. اهداف اصلی برای توسعه دهندگان با تجربه عبارتند از: 1. درک مدل داده و معماری OpenMRS 2. پیوستن به جامعه OpenMRS، یادگیری ابزارهای ارتباطی. 3. پیوندهایی به مخازن کد OpenMRS پیدا کنید. 4. منابع عمیق تری پیدا کنید.
طرح پروژه
مرحله برنامه ریزی: • اهداف تعیین شده در بخش دامنه را اصلاح کنید • محتوای قدیمی را شناسایی کنید • طرح کلی برای دو سند تهیه کنید • طرح کلی را به مربی و کارشناسان موضوع (SMEs) ارائه دهید • طرح پروژه را به روز کنید.
مرحله توسعه محتوا • Docker را یاد بگیرید، تمام مراحل نصب را طی کنید، و کد نمونه/کد آزمایشی ساده را تولید کنید • با SMEها برای پرسیدن سؤال مصاحبه کنید. اولین پیش نویس دو سند را توسعه دهید
بررسی و انتشار محتوا • خود محتوا را ویرایش کنید • پیش‌نویس‌های تکمیل‌شده را برای بازبینی‌کنندگان (مربی و SME) و کاربران نهایی ارسال کنید. • گزارش پروژه بنویسید
کار مقدماتی
من برخی کارها را روی محیط توسعه راه اندازی در سیستم لینوکس و راه اندازی OpenMRS SDK انجام داده ام. من در حال پیکربندی IDE هستم. من به کار بر روی ساخت ماژول های ساده و نوشتن کد تست ادامه خواهم داد.
مراجع و بحث
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy -for-new-developer-learner/18861/14 https://talk.openmrs.org/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a -possible-new-gsod-2020-project/28947