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

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

خلاصه ی پروژه

سازمان منبع باز:

Collective را باز کنید

نویسنده فنی:

Anna e só

نام پروژه:

بهبود اسناد کمک عمومی

طول پروژه:

طول استاندارد (3 ماه)

شرح پروژه

برداشت های اولیه این یک اتفاق معمول است که با صفحات اسناد حاوی دستورالعمل ها بدون رسانه پشتیبانی کننده (ویدئوها، فایل های GIF، تصاویر) روبرو می شوید، در حالی که سایر بخش های زیر همان فصل دارای ورودی های کامل تری هستند - به عنوان مثال، Edit Collective فقط از دستورالعمل ها تشکیل شده است در حالی که Add Fiscal Host شامل می شود. رسانه های حمایتی

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

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

اگرچه زبان مستندات فنی کاملاً سازگار است، اما راهنمای سبک در دسترس عموم، در مورد نحوه نگارش اسناد بسیار اندک است. از آنجایی که صفحه Contributing مشارکت در اسناد فنی را ذکر می کند، هم Open Collective و هم مشارکت کنندگان بالقوه از دستورالعمل های جامع تری بهره مند می شوند.

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

روش‌شناسی و جدول زمانی من می‌خواهم مستندات Open Collective را با کار در کنار جامعه برای ترویج چرخه‌های بازخورد مداوم با مدت زمان متفاوت بهبود بخشم.

دوره پیوند جامعه (1 اوت - 1 سپتامبر 2019): آشنایی با جامعه Open Collective! مصاحبه با اعضای فعال پروژه های برجسته و شروع کننده، پرسیدن سوال در مورد وضعیت فعلی اسناد (گزارش شماره 1). توجه به تمام سیستم های داخلی مورد استفاده برای ردیابی پرس و جوها و مسائل و فرآیند مستندسازی آنها در Open Collective Docs (گزارش شماره 2). ارزیابی مشکلات نهفته در نسخه فعلی مستندات و تهیه طرحی برای حل آنها (گزارش شماره 3).

2-6 سپتامبر: اولین چرخه بازخورد و تعدیل، با در نظر گرفتن تمام نظرات و پیشنهادات ارائه شده توسط جامعه در طول دوره پیوند جامعه. آیا برنامه ما برای رفتن خوب است؟ آیا چیزی در مورد آن وجود دارد که باید تغییر کند؟ (گزارش شماره 4)

9-20 سپتامبر: توسعه اثبات مفهوم با فصل کمتر پرجمعیت اسناد. پیش نویس یک راهنمای سبک عمومی (گزارش شماره 5).

23 الی 25 شهریور: ارائه اثبات مفهوم برای ارزیابی (گروه بسته).

26-27 سپتامبر: آیا اثبات مفهوم ما قبل از پخش زنده نیاز به تعدیل دارد؟ آیا به زمان بیشتری نیاز داریم؟ بر این اساس تنظیم کنید. (گزارش شماره 6)

30 سپتامبر - 9 اکتبر: اثبات مفهوم فعال می شود. چرخه دوم بازخورد (گروه عمومی).

10-15 اکتبر: اثبات نهایی ارزیابی مفهوم و چرخه تعدیل. (گزارش شماره 7)

16-20 اکتبر: استراحت کوچک از فعالیت ها [1].

21 اکتبر - 23 نوامبر: راهنمای سبک عمومی نهایی شد (گزارش شماره 8). اعمال تمام دستورالعمل های موجود در راهنمای سبک برای تمام صفحات مستندات کاربر (گزارش شماره 9). گزارش ارزیابی کلیه فعالیت های انجام شده و توصیه های بیشتر برای جامعه (گزارش شماره 10).

مدت زمان پروژه ممکن است در صورت درخواست تمدید شود.

[1]: سفری که قبل از برنامه Season of Docs من برنامه ریزی شده است.

محصولات تحویلی - ده گزارش عمومی در مورد فعالیت‌های انجام شده - یک راهنمای سبک عمومی هم از Open Collective و هم مشارکت‌کنندگان خارجی می‌توانند استفاده کنند - صفحات مستندات کاربر بازسازی‌شده