این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- داده های مشترک
- نویسنده فنی:
- کلیم آنجارو
- نام پروژه:
- بهبود اسناد شروع DataCommons
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
در حرفه‌ام به‌عنوان یک مهندس نرم‌افزار، بارها از تجربه پیوستن به یک تیم یا پروژه جدید، پایین کشیدن یک مخزن کد، اجرای آن و تماشای شکستن نرم‌افزار زمانی که مراحل کلیدی در مستندات وجود نداشت، ناامید شده‌ام. من به سرعت متوجه شدم که می توانم اشتیاق مادام العمر خود را برای نوشتن و آهنگسازی در این نیازها به کار ببرم و در این فرآیند یک محیط حمایتی برای توسعه دهندگانی که با آنها کار کردم ایجاد کنم تا به جای حل مشکلات با پاسخ های شناخته شده، بر نوآوری فنی و خلاقیت تمرکز کنند.
این نوآوری فنی و خلاقیت در بسیاری از بخش‌های جامعه، به ویژه توسط رهبران دولت و بخش غیرانتفاعی که به دنبال تجزیه و تحلیل مجموعه داده‌ها در فضاهای مشکل خود هستند، به فوریت مورد نیاز است. با در دسترس قرار دادن این داده‌ها به‌عنوان یک سرویس، DataCommons مانع ورود تحلیلگرانی که به دنبال داده‌هایی هستند که دسترسی آسان و نزدیک به فرمت مورد نیاز برای نقش‌هایشان است را کاهش می‌دهد. DataCommons این کار را با ایجاد یک نمودار دانش از داده‌هایی که دریافت می‌کند، انجام می‌دهد، در این فرآیند سؤالات جالبی در مورد کیفیت داده و حاکمیت در زمینه منبع باز ایجاد می‌کند. با درخواست در Google Summer of Docs با پیشنهادی برای سازمان DataCommons، امیدوارم بتوانم از این تلاش‌های فنی در فضای باز داده‌های باز منافع عمومی حمایت و پیش ببرم.
نقاط دردناک کنونی در مستندات با راه‌حل‌های پیشنهادی در حالی که وب‌سایت dataCommons حاوی دستورالعمل‌هایی برای افزودن مجموعه داده‌ها به dataCommons است، دستورالعمل‌ها بسیار کوتاه و نامشخص هستند و شامل چندین نقطه هستند که اهداکننده داده را به استفاده از نشانه‌گذاری schema.org هدایت می‌کنند. به عنوان بخشی از این پروژه، من پیشنهاد می‌کنم بخش «درگیر شوید» در dataCommons.org پاکسازی شود. من یک آموزش برای افزودن مجموعه داده های جدید ایجاد خواهم کرد و توضیح می دهم که چگونه مجموعه داده ها خراشیده می شوند و در نمودار دانش dataCommons گنجانده می شوند. من همچنین یک بخش پرسش‌های متداول را برای راه‌حل‌های رایجی که زمانی که صاحب مجموعه داده برای کمک به نگهبانان dataCommons مراجعه می‌کند، پیشنهاد می‌شود، اضافه می‌کنم.
با نگاهی به مجموعه نمونه های فعلی برای پرس و جو داده ها، dataCommons تنها چهار نمونه کد تعاملی را ارائه می دهد که همه آنها نوت بوک پایتون هستند. به عنوان بخشی از این پروژه، من این نوت‌بوک‌ها را به R ترجمه می‌کنم و همچنین نسخه‌های آزمایشی تعاملی نمونه‌های حاضر را برای Google Sheets و REST API ایجاد می‌کنم، و این نسخه‌های نمایشی را در مستندات فعلی جاسازی می‌کنم.
در نهایت، مستندات واقعاً هیچ نمونه ای از نحوه استفاده از نمودار دانش dataCommons برای ساخت برنامه های کاربردی در نرم افزار ارائه نمی دهد. به عنوان بخشی از این پروژه، من یک ابزار نمونه در پایتون ایجاد، استقرار و مستند می‌کنم که از dataCommons API استفاده می‌کند تا کاربر نهایی را قادر می‌سازد تا تجسم‌های گرافیکی مربوط به هر دو کمیت متصل به گراف دانش را بسازد. برای مثال، ممکن است بتوان از این ابزار برای ترسیم یک رگرسیون خطی که داده های آب و هوا را به اطلاعات الگوهای تجاری رایج مرتبط می کند، استفاده کرد. به عنوان یک هدف کششی، امیدوارم بتوانم این ابزار را به انواع دیگر تجسم ها، مانند نمودارهای دایره ای و نمودارهای ون گسترش دهم.
زمانبندی فصل از 14 سپتامبر تا 30 نوامبر اجرا می شود، بنابراین برنامه من برای تکمیل این پروژه به این صورت است:
سپتامبر: با بازنویسی بخش Get Involved شروع کنید. اکثراً این کار را تا پایان سپتامبر به پایان برسانید.
اکتبر: بخش Get Involved را جمع کنید و نمونه کدهای تعاملی را ایجاد کنید.
نوامبر: ابزار تجسم نمونه را ایجاد کنید.