عدم آشنایی صحیح دولوپرها با مستندسازی به ضرر نرم‌افزارهای آزاد تمام خواهد شد!

عدم آشنایی صحیح دولوپرها با مستندسازی به ضرر نرم‌افزارهای آزاد تمام خواهد شد!

گیت‌هاب گزارش اپن‌سورس 2017 خودش را منتشر کرد؛ این سرویس محبوب اشتراک‌گذاری سورس‌کد، از بیش از 5500 کاربر کامیونیتی خود گزارشی تهیه کرد که در بیش از 3800 پروژهٔ مختلف در گیت‌هاب مشارکت داشته‌اند. همچنین در این تحقیق با 500 دولوپر که پروژه‌هایشان خارج از اکوسیستم گیت‌هاب بوده، نیز مصاحبه شده است.

۲۰۱۷ Open Source Survey سؤال‌های متنوعی را در بر می‌گیرد؛ یکی از آن‌ها، در مورد مشکلاتی است که افراد، حین همکاری با پروژه‌های اپن‌سورس با آن‌ها برخورد می‌کنند (برای کسب اطلاعات بیشتر پیرامون این موضوع، به مقالهٔ نظرسنجی گیت‌هاب که هدفش شناخت افراد نامناسب در حوزۀ اپن‌سورس است! مراجعه نمایید). جالب توجه است که 93 درصد افراد بیان کردند در مورد «مستندسازی ناقص یا گمراه‌کننده» به مشکل خورده‌اند.

البته این قضیه اصلاً باعث تعجب نیست؛ پروژه‌های بی‌شماری در گیت‌هاب وجود دارد که هرکدام دارای توضیحات کم و دستورالعمل‌های کوتاهی در مورد نحوهٔ استفاده از آن‌ها هستند که در این مواقع اگر به‌اندازهٔ کافی‌ توان و حوصلهٔ سروکله زدن با مشکلات را نداشته باشید، مشکل است بتوانید به هدف‌تان برسید.

مستندسازی یک باید است
متأسفانه، افراد زیادی وجود دارند که اهمیت مستندسازی مناسب را در موفقیت یک پروژه درک نمی‌کنند؛ Mike Pope یکی از نویسندگان فنی و مورد احترام سایر دولوپرها، اینچنین نظر خود را دربارهٔ Documentation بیان می‌کند:

ما به این خاطر شناخته شدیم که به دولوپرها می‌گیم «اگه مستندسازی نشده، پس وجود نداره». نه‌تنها باید مستندسازی انجام بشه، بلکه پروژه رو باید توصیف هم کردش، آموزش داد و نمایش داد. اگر این کارها رو به‌درستی انجام بدیم، مخاطب‌ جذب میشه، نه به مستندسازی‌تون، بلکه به محصول‌تون.

دیدگاه دیگری از دولوپر جاوااسکریپت Nicholas Zakas با مضمون زیر وجود دارد:

مهم نیست لایبرری شما چقدر خوبه یا طراحی و عملکرد عالی‌ای داره، اگه شما تنها کسی هستید که اون لایبرری رو حالیتون می‌شه، دیگه اصلاً خوب نیست! مستندسازی نه‌تنها به‌معنی ساخت خودکار منابع API هست، بلکه در مورد تفسیر مثال‌ها و آموزش‌های عمیق‌تر نیز کاربرد داره. به هر سهٔ این موارد نیاز دارید تا مطمئن شید لایبرری‌تون به‌راحتی فهمیده میشه.

به جز دلایل کاربردی، این مسأله هم صحیح است که مستندسازی باعث ایجاد یک کامیونیتی می‌شود؛ به این ترتیب، نه‌تنها می‌دانید همکاران‌تان چه کسانی هستند و چه چیزهایی را تولید کرده‌اند، بلکه اهداف و کارهای آینده نیز کاملاً مشخص است. 

Open Source Survey که توسط گیت‌هاب صورت می‌گیرد در این رابطه بیان می‌کند که مستندسازی به ساخت کامیونیتی‌های فراگیر کمک می‌کند. درواقع، مستندسازی‌ای که به‌طور واضح روند پیشرفت پروژه مثل اهداف مشارکت و جریان موجود در کدها را توصیف می‌کند، بین گروه‌هایی که کمتر در اپن‌سورس دیده می‌شوند -مثل بانوان- ارزش بیشتری خواهد داشت.

مستندسازی سخت است، و این مسأله‌ای پذیرفته‌شده است!
طبق گزارش اپن‌سورس گیت‌هاب، 60 درصد مشارکت‌کنندگان همکاری بسیار کم و یا هیچ مشارکتی در مستندسازی ندارند؛ مستندسازی نرم‌افزار به‌طور قابل‌ملاحظه‌ای سخت است. افراد برای تبدیل شدن به نویسندگان حرفه‌ای، به دانشگاه می‌روند و مقدار زیادی وقت و هزینه صرف می‌کنند تا به هدف خود برسند. منطقی نیست انتظار داشته باشیم هر دولوپری، نحوهٔ صحیح نوشتن مستندات را بداند یا آ‌ن‌را به‌درستی انجام دهد.

حقیقت دیگری وجود دارد که 25 درصد مشارکت کنندگان اپن‌سورس، توانایی خواندن و نوشتن زبان انگلیسی‌شان را کمتر از حد خوب توصیف کرده‌اند ولی درعین‌حال فرصت خوبی وجود دارد که شرکت‌های پیشرو مانند گوگل و گیت‌هاب به این مسأله بپردازند.

گوگل اخیراً دورهٔ آنلاین و رایگانی را شروع کرده که قصد دارد متخصصین زبان را به مترجم نرم‌افزار تبدیل کند. عکس این قضیه هم می‌تواند صادق باشد به این شکل که چرا این کار را در مورد نویسندگان داستان و رمان انجام ندهد و مهارت‌های لازم برای نوشتن مستندات دربارهٔ نرم‌افزارها را به آن‌ها آموزش ندهد؟

گیت‌هاب هم درصدد است دوره‌ای برای آشنایی نویسندگانی که هیچ تجربه‌ای در توسعهٔ نرم‌افزار با گیت ندارند آغاز کند؛ این کار نه‌تنها کمک به مسألهٔ مستندسازی می‌کند، بلکه روشن می‌سازد که برای مشارکت با جریان اپن‌سورس لازم نیست حتماً دولوپر باشید!

حال نوبت به نظرات شما می‌رسد؛ آیا شما هم جزو دولوپرهایی هستید که فقط و فقط خودشان از سورس‌کدشان سر درمی‌آورند یا این‌که به حرفه‌ای‌ترین شکل ممکن کدهای خود را مستندسازی می‌کنید؟ نظرات، دیدگاه‌ها و تجربیات خود را در این خصوص با ما و سایر کاربران سکان آکادمی به اشتراک بگذارید.

منبع


مرتضی صمدی