پروژه بنیاد ویکی مدیا

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه ی پروژه

سازمان منبع باز:
بنیاد ویکی مدیا
نویسنده فنی:
پاویترا اسوارامورتی
نام پروژه:
بهبود اسناد برای مستندسازان فنی و فیلمبرداران ویکی‌مدیا
طول پروژه:
طول استاندارد (3 ماه)

شرح پروژه

1. درباره من

من چند ماه پیش با نرم افزار منبع باز آشنا شدم و تقریباً بلافاصله تحت تأثیر دامنه نامحدود آن قرار گرفتم. در تلاش برای راهیابی به پروژه‌های بی‌نظیر، در مورد ابتکارات منبع باز مانند Google Summer of Code و Outreachy یاد گرفتم. فصل Google Docs جالب به نظر می رسید و ایده های پروژه توسط بنیاد ویکی مدیا کنجکاوی من را برانگیخت، بنابراین، شروع به کاوش بیشتر کردم.

سفر من تاکنون به همان اندازه هیجان‌انگیز و گیج‌کننده بوده است، پر از «صبر کن، چی؟»، «آه، متوجه شدم!» و "آیا باید در این مورد نظر بدهم؟". جامعه ویکی مدیا در هر مرحله از او حمایت کرده است. از ویرایش صفحات تا ایجاد برنامه های افزودنی، هر روز چیز جدیدی یاد گرفته ام.

همانطور که انتظار می رفت، فرآیند درخواست به عنوان دروازه من برای ورود به جامعه منبع باز بود. این پیشنهاد از تجربیات خودم به عنوان یک مبتدی الهام گرفته شده است.

2. پروژه

2.1. طرح کلی

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

2.2. تحویل دادنی ها

  • T197006 [https://phabricator.wikimedia.org/T197006] - بهبود اسناد برای مستندسازان ویکی‌مدیا:

    • نکات و مثال‌هایی را به راهنمای مستندات/سبک اضافه کنید. [https://www.mediawiki.org/wiki/Documentation/Style_guide]
    • اطلاعات خاص مدیاویکی را به ژانرهای خاص در قالب‌ها و پیشنهادات مستندات فنی اضافه کنید: راهنماهای کاربر، نحوه کار، راهنماهای شروع سریع، یادداشت‌های انتشار و README. [https://www.mediawiki.org/wiki/Technical_documentation_templates_and_suggestions]
    • آزمایش و بهبود دستورالعمل ها برای اولویت بندی اسناد فنی. [https://www.mediawiki.org/wiki/Technical_documentation_prioritization]
    • یک استراتژی جمع آوری محتوا برای ژانرهای مختلف مستندسازی طراحی کنید.
    • یک استراتژی ارتباطی و همکاری برای اسناد مدیاویکی طراحی کنید.
    • چک لیستی ایجاد کنید که نویسندگان بتوانند اسناد خود را قبل از انتشار بررسی کنند.
    • ساختار اسناد را برای نویسندگان فنی جدید گسترش دهید. [https://www.mediawiki.org/wiki/User:Pavithraes/Sandbox/New_Technical_Writers]
    • فهرستی از وظایف مستندات فنی مناسب برای هکاتون ها را تهیه کنید. [https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons]
    • یک مرکز نویسنده فنی ایجاد کنید که به منابع مفید اشاره کند.

  • بهبود اسناد برای فیلمبرداران مدیاویکی:

    • یک راهنمای کاربر سریع برای ساخت یک نمایش کلی صفحه ایجاد کنید.
    • قالب‌های نمایشگر مخصوص مدیاویکی را برای توضیحات و آموزش‌ها طراحی کنید.

  • T214522 [https://phabricator.wikimedia.org/T214522]- یک صفحه نمایش «مقدمه ای بر Phabricator» ایجاد کنید.

2.3. هدف کششی

  • دوباره محتوا را بررسی کنید و اسناد ویکی‌پروژه Screencast را به‌روزرسانی کنید. (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Screencast)

3. مربیان

زولیپ حالت اولیه ارتباط با مربیان من خواهد بود. کانال‌های IRC و ایمیل ویکی‌مدیا برای گفتگو با جامعه مورد استفاده قرار خواهند گرفت. بحث در مورد وظایف خاص در بخش نظرات وظایف Phabricator انجام خواهد شد.

4. بحث

این پروژه به طور کلی به دو مرحله تقسیم می شود:

(i) بهبود منابع موجود برای نویسندگان فنی ویکی‌مدیا.

(ii) الگوهای مفیدی برای فیلمبرداران بالقوه ایجاد کنید.

(i) بهبود منابع موجود برای نویسندگان فنی ویکی‌مدیا.

در گذشته، چندین ابتکار برای بهبود مستندات مدیاویکی با درجات مختلف موفقیت وجود داشته است. چندتا را نام بردن:

  • https://www.mediawiki.org/wiki/User:Zakgreant/Tech_Docs Plan (2011--01/P6M)
  • https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan
  • https://www.mediawiki.org/wiki/Thread:Project:Current_issues/Restructure MediaWiki.org (یا:_Document_how_it_was_and_execute_it)
  • https://www.mediawiki.org/wiki/User:Waldir/Docs

از این تلاش ها می توان فهمید که مجموعه ای از منابع بهتر برای نویسندگان فنی تأثیر مستقیمی بر اسناد تولید شده توسط آنها خواهد داشت.

بخش زیر بخشی از گزارش دو هفته‌ای یک کارآموز Outreachy 2018، Anna e só https://anna.flourishing.stream/2018/01/18/bringing-documentation-to-light/ است:

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

T197006 [https://phabricator.wikimedia.org/T197006] همچنین زمینه های خاصی از اسناد نوشتاری فنی را که نیاز به بهبود دارند روشن می کند. واضح است که Documentation/Style_guide مکانی برای شروع است.

هنگامی که راهنمای سبک بهتری داشته باشیم، مجموعه اسناد بعدی برای راهنمایی نویسندگان فنی در مراحل مختلف نگارش فنی برنامه ریزی شده است. این اسناد باید برای مبتدیان باشد و در عین حال تمام اطلاعات لازم را برای نویسندگان ارائه دهد تا به آنها مراجعه کنند.

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

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

حتی با وجود این اسناد، نویسندگان فنی جدید نیاز به کمک اضافی دارند و ما باید به آنها کمک کنیم. راهنمای نویسندگان فنی جدید اصلاح شده است و لیستی از وظایف مناسب برای هکاتون بر اساس سطح دشواری تنظیم شده است.

در نهایت، سندی برای درک فرآیند مدیریت و نگهداری اسناد - "اولویت بندی اسناد فنی" آزمایش و بهبود می یابد.

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

(ii) الگوهای مفیدی برای فیلمبرداران بالقوه ایجاد کنید.

یکی از سخت‌ترین راه‌ها برای یادگیری هر چیزی که شامل گرافیک است، خواندن متن ساده است. همچنین تصور کنید چه اتفاقی می‌افتد اگر کتابچه راهنمای شما به نسخه اشتباه نرم‌افزار ارجاع دهد - با دستورالعمل‌های متنی، اغلب زمانی که منوها و عبارت‌های برنامه تغییر می‌کنند، ایجاد مجدد یک سری اقدامات غیرممکن می‌شود، زیرا ما همه نشانه‌هایی را که معمولاً می‌توانیم نداشتیم. استفاده کنید.

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

ما همچنین می‌توانیم زیرنویس‌های ترجمه‌شده را به یک اسکرین‌پست اضافه کنیم تا توسط سخنرانان غیر بومی قابل مشاهده باشند یا آهنگ صوتی را با زبان‌های جایگزین جایگزین کنیم.»

ایان اوزوالد در قسمت بالا از «راهنمای نمایش‌دهی» [https://thescreencastinghandbook.com/wp-content/uploads/The_Screencasting_Handbook_rel10_20100502_v6.pdf] اهمیت فیلم‌برداری را توضیح می‌دهد. این می تواند به ویژه برای آموزش های مربوط به راه اندازی محیط توسعه MediaWiki، نوشتن برنامه های افزودنی، استفاده از Gerrit و موارد دیگر مفید باشد.

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

بهترین راه برای آزمایش الگوی بالا و آماده شدن برای هدف کششی، ایجاد یک صفحه نمایش با استفاده از ابزارها و الگوها است. از این رو، یک صفحه نمایش "مقدمه ای بر Phabricator" ایجاد می شود که اصول اولیه استفاده از Phabricator را پوشش می دهد. این فرآیند همچنین زمینه هایی را که نیاز به بحث دارند برجسته می کند.

در نهایت، منبع اصلی مرجع فیلمبرداران ویکی‌مدیا - WikiProject Screencast بررسی و به‌روزرسانی می‌شود.

5. جدول زمانی آزمایشی

دوره پیوند جامعه (1 آگوست - 1 سپتامبر)

  • پروژه را به طور مفصل با مربیانم تجزیه و تحلیل کنید.

  • بحث در مورد:

    • هر چند وقت یکبار باید وظایف بررسی شوند.
    • برنامه ها را به اشتراک بگذارید و در مورد گردش کار هفتگی/روزانه تصمیم بگیرید.
    • ابزارها و منابع قابل استفاده.
    • گزارش پروژه های دو هفته ای و روزانه.

  • وظایف و زیرکارهای مورد نیاز را در Phabricator ایجاد کنید.

  • پیش نویس هایی برای جبران تعهدات شخصی در مرحله توسعه سند ایجاد کنید.

هفته 1 (2 - 8 سپتامبر)

  • Documentation/Style_guide را بهبود ببخشید:

    • تمرکز اصلی را برای نشان دادن بهترین شیوه ها و استانداردها در مدیاویکی تغییر دهید.
    • نمونه هایی از کارهای خوب را درج کنید و دید صفحات مرتبط را بهبود بخشید.

  • بهبود راهنمای نویسندگان تکنیکال جدید:

    • ساختار اسناد را گسترش دهید.

هفته 2 (9 تا 15 سپتامبر)

  • کار بر روی اولویت بندی اسناد فنی:

    • ارزیابی صفحه کار مستندسازی؛ نمونه هایی از شرح وظایف خوب و اولویت بندی را بیابید.
    • روندها را مطالعه کنید و مشکلات رایج را یادداشت کنید.
    • از اطلاعات و مثال ها برای مستندسازی استانداردهای اولویت بندی استفاده کنید.

هفته 3 (16 تا 22 سپتامبر)

  • اسناد اضافی زیر را برای نویسندگان فنی ایجاد کنید:

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

هفته 4 (23 تا 29 سپتامبر)

  • اطلاعاتی درباره نوشتن در رایج‌ترین ژانرهای مدیاویکی به الگوها و پیشنهادات مستندات فنی اضافه کنید:

    • بهترین روش‌ها را در مدیاویکی برای نوشتن راهنماهای کاربر، راهنماهای شروع سریع، READMEها، یادداشت‌های انتشار و روش‌ها مستند کنید.

  • جهت بهبود بلوغ ارتباطات فنی را اضافه کنید. [https://www.mediawiki.org/wiki/User:SRodlund_(WMF)/Maturity_model_for_MediaWiki_technical_documentation#افزایش بلوغ --_strategic_directions]

هفته 5 (30 سپتامبر - 6 اکتبر)

  • بهبود اسناد برای همکاران جدید در داخل هواپیما:

    • به روز رسانی صفحه: وظایف مستندات فنی برای هکاتون ها. (کارها: کارهای مناسب را در طول دوره پروژه به این صفحه اضافه کنید)

  • یک مرکز نویسنده فنی بسازید

    • یک صفحه فرود با پیوندهایی به صفحات و منابع مفید ایجاد کنید.
    • پیوندهای لازم را به صفحات جدید و موجود اضافه کنید تا راحت تر بین آنها پیمایش کنید.

هفته 6 (7 تا 13 اکتبر)

  • اسناد زیر را در مورد ساخت ویدیو برای مدیاویکی ایجاد کنید:

    • یک راهنمای کاربر سریع در مورد "ایجاد یک نمایش کلی" که به پروژه Screencast اشاره می کند.
    • الگوهایی برای: توضیحاتی در مورد استفاده از یک نرم افزار/ابزار. آموزش ساخت ابزارهای جدید.

  • فهرستی از ایده‌های نمایش‌دهی برای مدیاویکی ایجاد کنید.

هفته 7 (14 تا 20 اکتبر)

  • روی ویدیوی "معرفی فابریکاتور" کار کنید:

    • برای پیش نویس یک اسکریپت از الگو (که هفته قبل ایجاد شد) استفاده کنید.
    • کارایی قالب را تخمین بزنید و در صورت لزوم آن را بهبود ببخشید.
    • بازخورد دریافت کنید و پیش نویس را نهایی کنید.

هفته 8 (21 تا 27 اکتبر)

  • انتشار ویدیوی «معرفی فابریکاتور»:

    • نرم افزار را انتخاب و نصب کنید.
    • محیط را تنظیم کنید و صفحه نمایش را ایجاد کنید.
    • مشکلات پیش آمده و راه حل ها را یادداشت کنید.

هفته 9 (28 اکتبر - 3 نوامبر)

  • کار برای بهبود مستندات پروژه Screencast:

    • ساختار را بررسی کنید و در مورد نیاز به تغییر بحث کنید.
    • نرم افزارهای ذکر شده را بررسی کنید.
    • لیست نرم افزارها را تحقیق و به روز کنید.

هفته 10 (4 تا 10 نوامبر)

  • به بهبود مستندات پروژه Screencast ادامه دهید:

    • آموزش و اسکریپت ها را ارزیابی و بهبود بخشید.
    • گالری اسکرین‌کست را مرور کنید.

هفته 11 (11 تا 17 نوامبر)

  • کار روی مستندات پروژه Screencast را کامل کنید:

    • ویدیوهای جدیدتر را به گالری بیابید و اضافه کنید.
    • تغییرات ساختاری لازم را انجام دهید.

هفته 12 (18 تا 24 نوامبر)

  • روی هر کار معلق کار کنید.

  • گزارش نهایی را بنویسید:

    • به گزارش های دو هفته ای/روزانه مراجعه کنید و اطلاعات مورد نیاز را جمع آوری کنید.
    • ساختار گزارش را برنامه ریزی کنید و پیش نویس بنویسید.
    • پیش نویس را بر اساس بازخورد مربی بهبود و نهایی کنید.

هفته 13 (25 تا 29 نوامبر)

  • ارائه گزارش نهایی و ارزیابی مربی.

6. پیگیری پیشرفت

به روز رسانی های پیشرفت روزانه از طریق Zulip به مربیان من اطلاع رسانی خواهد شد. انجمن ویکی‌مدیا می‌تواند پیشرفت من را از طریق Phabricator یا گزارش‌های دو هفته‌ای پروژه دنبال کند.

7. سایر تعهدات

من یک دانشجوی کالج تمام وقت هستم و ترم پاییز تحصیلی من با جدول زمانی Season of Docs همپوشانی دارد. از این رو، تعهدات من شامل امتحانات دانشگاه است.

اولین آزمون داخلی: 18 الی 24 مرداد

آزمون داخلی دوم: 29 شهریور لغایت 6 مهر

آزمون پایان ترم: 11 الی 30 آبان

من همچنین قصد دارم در اولین کنفرانس عمومی خود، PyCon India از 12 تا 15 اکتبر، به لطف مکان مناسب امسال، شرکت کنم. من معتقدم که این یک فرصت عالی برای ملاقات با افراد جدید و گفتگوهای روشنگر خواهد بود.

برای مدیریت این تعهدات، جدول زمانی آزمایشی شامل وظایف با وزن کمتر در هفته های مربوطه است. من قصد دارم بیش از 20 واحد اصلی را در ترم پاییز تکمیل کنم تا زمان کافی برای توسعه مدرک داشته باشم. (یک دانشجوی عادی به طور متوسط ​​در هر ترم 25 واحد درسی می گذراند)