این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- مهم ترین
- نویسنده فنی:
- @anindita_basu
- نام پروژه:
- بررسی و اصلاح متن درون محصول
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
من به کانال اسلک پیوستم و چند سوال از اریک پرسیدم. مستقر
در پاسخ او (از شما متشکرم، اریک!)، من پیشنهاد می کنم به این پروژه نزدیک شوید
به روش زیر:
رشته ها را طبقه بندی کنید
من با شناسایی اینکه کدام یک از رشته‌ها ( https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json ) کنسول‌های سیستم هستند و کدام‌ها رو به روی کاربر هستند، شروع می‌کنم. من پیشنهاد می‌کنم در ابتدا رشته‌های کاربر را برای بازبینی در نظر بگیریم.
یک راهنمای سبک برای رشته ها ایجاد کنید
می‌خواهم برای رشته‌های مورد استفاده در آیتم‌های منو، دکمه‌های کنش، برچسب‌ها، سرفصل‌ها، نکات ابزار، خطاها، هشدارها، اعتبارسنجی‌ها، اعلان‌ها و تأییدیه‌ها، سبک را برای حروف بزرگ، طول و استفاده از کلمه تعریف کنم (نمونه تصویری از راهنمای سبک در https را ببینید. ://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG ). همچنین، من می‌خواهم راهنمایی‌هایی در مورد استفاده از نشانه‌ها (مکان‌ها) در رشته‌ها، به‌ویژه رشته‌های مرکب ایجاد کنم.
من قصد دارم این راهنما را در یک صفحه از یک برگه با اندازه A4 نگه دارم، در صورت امکان کوتاهتر. هدف از این قرار، توسعه‌دهندگانی که واقعاً این رشته‌ها را می‌نویسند، باید راهنمایی را سریع و آسان برای استفاده پیدا کنند، به‌علاوه، وقتی دنبال می‌شوند، متن UI در همه صفحه‌ها یکنواخت نشان می‌دهد.
من این کار را به دو دلیل پیشنهاد می‌کنم: (الف) به طوری که در متن از نظر دستور زبان و سبک سازگاری وجود داشته باشد (ب) به طوری که حتی پس از پایان GSoD، مجموعه‌ای از دستورالعمل‌ها وجود دارد که هر کسی می‌تواند به سرعت به آنها مراجعه کند. آنها متن UI را می نویسند
متن را مرور و اصلاح کنید
بر اساس راهنمای سبک ایجاد شده در شماره 2، رشته ها را ویرایش می کنم و درخواست های کششی را در GitHub ایجاد می کنم.
==============
مدت زمان
من هنوز نمی‌دانم چه تعداد از رشته‌ها رشته‌های رو به کاربر هستند (که پیشنهاد می‌کنم در این پروژه بررسی شود). من تخمین می زنم که ایجاد راهنمای سبک حدود 3 هفته طول می کشد (از پیش نویس تا تایید)، و این کار را می توان همزمان با دسته بندی رشته ها به عنوان رشته های سیستم یا روبروی کاربر انجام داد. من پیشنهاد می‌کنم با این فرض شروع کنم که پروژه یک پروژه با طول استاندارد (3 ماه) خواهد بود، که در آن فقط تعداد زیادی رشته را برای بررسی در این چارچوب زمانی می‌گیرم.
از آنجایی که من در حال حاضر به طور تمام وقت مشغول به کار هستم، می توانم فقط بخشی از روز را روی این پروژه کار کنم. اگر فکر می‌کنید کاهش ساعات کاری من به آن نیاز دارد، می‌خواهم پروژه طولانی‌تری داشته باشم.