این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- ScummVM
- نویسنده فنی:
- کادی
- نام پروژه:
- یک پورتال مستندات راه اندازی کنید
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
اهداف:
- برای تولید اسناد کاربر نهایی با کیفیت بالا و نسخه‌شده با ادغام مقادیر زیادی از اطلاعات از منابع متفاوت و بازنویسی اطلاعات برای وضوح، سازگاری و کامل بودن.
- درک مستندات باید برای مبتدیان آسان باشد، بدون اینکه از کاربران باهوش فناوری حمایت شود.
- برای ایجاد یک پورتال مستندات با استفاده از یک مولد سایت استاتیک.
- با ایجاد الگوها و دستورالعمل‌های دقیق نحوه کار برای مشارکت‌کنندگان منبع باز آینده، اسناد کاربر نهایی را برای آینده اثبات کنید.
وضعیت فعلی:
- اسناد ScummVM موجود در چندین منبع پخش شده است.
- اطلاعات به سختی یافت می شود و اغلب تکراری است. گم شدن در صفحات مبهم آسان است.
- سخت است که بدانید چه اطلاعاتی به روز هستند و چه اطلاعاتی قدیمی هستند.
- برخی از اطلاعات گم شده یا ناقص است.
رفع مشکل:
ساختار اسناد پیشنهادی:
صفحه فرود |-- شروع به کار | -- Quick start guide |-- Installing ScummVM | |-- Nintendo 3DS | |-- AmigaOS | |-- Android | |-- (every) | |-- (common) | |-- (supported) | -- (پلتفرم) |-- استفاده از ScummVM | |-- پرتاب کننده | |-- تنظیمات جهانی | |-- تنظیمات بازی | -- Keyboard shortcuts |-- Advanced options | |-- Cloud and LAN | |-- Control Mapping | |-- Configuration | |-- Command line options | |-- Graphics | -- موسیقی و صدا |-- راهنما | |-- سوالات متداول | |-- مخاطبین | |-- مشکلات شناخته شده | -- Reporting a bug |-- Game Notes -- یادداشت های انتشار
- شروع به کار:
کاربران جدید اغلب به دنبال راهنمای شروع سریع هستند تا در سریع ترین زمان ممکن کار کنند. در حالی که نصب ScummVM در برخی از پلتفرم‌ها می‌تواند پیچیده باشد، نصب آن بر روی رایانه اینطور نیست.
راهنمای شروع سریع باید موارد زیر را پوشش دهد:
- نحوه نصب ScummVM بر روی ویندوز، مک و لینوکس.
چگونه یک بازی را بارگیری، اضافه و راه اندازی کنیم.
نصب ScummVM:
در مواردی که نصب بصری نیست، یا کاربر ممکن است پایه فنی قوی نداشته باشد، کاربر به یک راهنمای جامع برای نصب ScummVM در هر یک از پلتفرم‌های پشتیبانی شده نیاز دارد.
هر صفحه نصب جامع باید موارد زیر را پوشش دهد:
- هرگونه نیاز/پیش نیاز سیستم
- نحوه دانلود نسخه مناسب ScummVM.
- نحوه نصب ScummVM
- نحوه بارگذاری بازی ها روی پلتفرم انتخابی، به خصوص در جایی که پلتفرمی که بازی برای آن طراحی شده نیست، نیست.
نحوه راه اندازی ScummVM، اضافه کردن یک بازی و راه اندازی یک بازی.
استفاده از ScummVM:
کاربران به اسناد مرجع نیاز دارند که نحوه استفاده از ScummVM را توضیح دهد.
اسناد مرجع باید شامل موارد زیر باشد:
- رابط لانچر؛ ظاهر هر پنجره و تب و همچنین نحوه عملکرد آنها.
- توضیحی در مورد تنظیمات موجود، هم جهانی و هم مخصوص بازی.
میانبرهای صفحه کلید/کلیدهای فوری.
گزینه های پیشرفته:
کاربران پیشرفته به اطلاعات فنی بیشتر و بیشتر در مورد گزینه های موجود برای بهینه سازی نحوه اجرای بازی هایشان نیاز دارند.
- نکات بازی:
هر گونه اطلاعات مربوط به بازی که کاربر باید بداند؛ شامل، اما نه محدود به: - ویژگی‌های نصب - هر گونه فایل اضافی مورد نیاز - کنترل‌های غیرمعمول یا متفاوت
- مشکلات شناخته شده:
این بخش باید حاوی هر گونه اشکال شناخته شده مخصوص انتشار باشد.
- یادداشت های انتشار:
در حالی که اسناد ما نسخه‌بندی می‌شوند، داشتن بخش یادداشت‌های انتشار ممکن است برای ارائه خلاصه‌ای از تغییرات در آخرین نسخه مفید باشد. این ممکن است شامل برخی از حوزه‌هایی باشد که در حال حاضر خارج از محدوده این مستندات هستند، مانند بازی‌هایی که به تازگی پشتیبانی می‌شوند یا اطلاعاتی درباره موتورهای جدید.
طرح حمله:
من پیشنهاد می‌کنم با ایجاد یک الگو برای نصب صفحات ScummVM شروع کنم، زیرا این ساده‌ترین راه برای من برای دریافت اطلاعاتی است که از نگهبانان/توسعه‌دهندگان پورت می‌خواهم (مخصوصاً در مواردی که این اطلاعات کم است یا وجود ندارد). من هر اطلاعاتی را که از قبل از اسناد موجود دارم از قبل پر می کنم، که می توان آن را از نظر کامل بودن، دقت و ارز بررسی کرد یا در صورت لزوم به آن اضافه کرد.
در مرحله بعد اسناد موجود را بررسی خواهم کرد. README، ویکی و وب سایت. همانطور که می روم، دوباره می نویسم و در صورت نیاز به هر بخش اضافه می کنم و تمام اطلاعات را به پورتال جدید می کشم. همچنین یادداشت می‌کنم که چه اطلاعاتی از کجا استخراج می‌شوند تا اطمینان حاصل کنم که پس از فعال شدن پورتال، هیچ‌گونه تکرار، تناقض یا ناهنجاری دیگری وجود ندارد.
در تمام طول مدت، من با مربی(ها)، توسعه دهندگان، نگهبانان بندر، و هر متخصص موضوع دیگری ارتباط برقرار خواهم کرد تا اطلاعات گمشده را تهیه کنم و همچنین اطمینان حاصل کنم که هر صفحه تا حد امکان به روز و جامع است.
با روحیه همکاری و مشروط به تایید استاد یا مربیان، من می‌خواهم پورتال در حال انجام را در طول فرآیند نوشتن برای جامعه ScummVM در دسترس داشته باشم تا بازخورد بلادرنگ دریافت کنم و اطمینان حاصل کنم که هیچ چیزی از قلم نیفتاده است. راه
من پیشنهاد می‌کنم از یک راهنمای سبک، مانند راهنمای سبک مستندسازی توسعه‌دهنده Google استفاده کنید تا از یکنواختی برای این مجموعه کار و برای همه اسناد رو به جلو اطمینان حاصل کنید.
تا جایی که امکان داشته باشد، از اسکرین شات، گیف و سایر وسایل کمک بصری برای افزایش درک استفاده خواهم کرد.
جدول زمانی پیشنهادی:
پیوند جامعه 17 اوت - 13 سپتامبر 2020
برای تنظیم دقیق چشم انداز پروژه و نهایی کردن جزئیاتی مانند ساختار و محتوای سند، وقت خود را صرف صحبت با مربی(ها) و جامعه گسترده تر ScummVM کنید.
هفته 1 14 سپتامبر - 20 سپتامبر
- یک الگو برای صفحات نصب مخصوص پلتفرم ایجاد کنید.
- الگوها را از قبل با هر گونه اطلاعات موجود پر کنید و برای اطلاعات بیشتر در اختیار نگهبانان/توسعه دهندگان پورت مناسب قرار دهید.
هفته 2 21 سپتامبر - 27 سپتامبر
- پورتال اسناد جدید را راه اندازی کنید.
هفته 3 28 سپتامبر - 4 اکتبر
استفاده از ScummVM: - رابط - تنظیمات جهانی نصب ScummVM: - راهنمای نصب پلتفرم خاص به عنوان الگوهای تکمیل شده به من بازگردانده می شود.
هفته 4 5 اکتبر - 11 اکتبر
استفاده از ScummVM: - تنظیمات بازی - میانبرهای صفحه کلید نصب ScummVM: - راهنمای نصب مخصوص پلتفرم به عنوان الگوهای تکمیل شده به من بازگردانده می شود
هفته 5 12 اکتبر - 18 اکتبر
گزینه های پیشرفته: - Cloud و LAN - Control Mapping نصب ScummVM: - راهنمای نصب پلتفرم خاص به عنوان الگوهای تکمیل شده به من بازگردانده می شود
هفته 6 19 اکتبر - 25 اکتبر
گزینه های پیشرفته: - پیکربندی - گزینه های خط فرمان نصب ScummVM: - راهنماهای نصب پلتفرم خاص به عنوان الگوهای تکمیل شده به من بازگردانده می شود
هفته 7 26 اکتبر - 1 نوامبر
گزینه های پیشرفته: - گرافیک - نصب صوتی ScummVM: - راهنمای نصب پلتفرم خاص به عنوان الگوهای تکمیل شده به من بازگردانده می شود
هفته 8 نوامبر 2 - 8 نوامبر
راهنما: - سوالات متداول - مخاطبین - مشکلات شناخته شده
نصب ScummVM: - راهنمای نصب پلتفرم خاص به عنوان الگوهای تکمیل شده به من بازگردانده می شود
هفته 9 نوامبر 9 - 15 نوامبر
راهنما: - گزارش یک اشکال - یادداشت‌های بازی - یادداشت‌های انتشار
نصب ScummVM: - تمام راهنماهای پلتفرم که هنوز تکمیل نشده اند را نهایی کنید.
هفته 10 نوامبر 16 - 22 نوامبر
- ویرایش نهایی، تصحیح و نهایی کردن تصمیمات مربوط به پورتال مانند ناوبری نوار کناری، تغییرات تم/CSS و غیره.
- اطمینان حاصل کنید که همه پیوندها همانطور که انتظار می رود کار می کنند.
- نمایش تصاویر/گیف ها را به درستی بررسی کنید.
هفته 11 نوامبر 23 - 30 نوامبر
- تمام موارد برجسته را نهایی کنید و پورتال را به طور رسمی راه اندازی کنید!
- پس از راه اندازی پورتال، اطلاعات اضافی را از منابع دیگر با مشورت مربی(های) حذف کنید.