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

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

GitHub در سال 2017 به نظرسنجی از بیش از 5500 کاربر کامیونیتی خود پرداخت که در بیش از 3800 پروژهٔ مختلف مشارکت داشته‌اند که یکی از سؤالات این نظرسنجی در مورد مشکلاتی بود که دولوپرها حین همکاری با پروژه‌های اپن‌سورس با آن‌ها برخورد کرده‌اند و جالب است بدانید که در این نظرسنجی ٪93 از افراد گفتند که به دلیل مستندسازی‌ ناقص یا اطلاعات گمراه‌کننده به مشکل خورده‌اند!

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

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

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

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

یافتهٔ دیگری که از این نظرسنجی کشف شد این است که ٪25 مشارکت‌کنندگان اپن‌سورس توانایی خواندن و نوشتن زبان انگلیسی‌شان را کمتر از حد خوب توصیف کردند که این هم به نوبهٔ خود مسئله‌ای چالش‌برانگیز است (در همین راستا، کمپانی گوگل دورهٔ آنلاین و رایگانی را تحت عنوان Localization Essentials در Udacity برگزار کرده که هدف اصلی‌اش این است تا متخصصین زبان را به مترجم نرم‌افزار مبدل سازد.) 

منبع