این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- SymPy
- نویسنده فنی:
- با کمال میل
- نام پروژه:
- سازگاری بین رشته‌های اسنادی
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
برای این پروژه، هدف من ایجاد سازگاری بیشتر با رشته‌های مستند SymPy است.
با کار با مربیانم، ابتدا قالب بندی مورد نظر را برای یک رشته مستند در پایگاه کد شناسایی می کنم. سپس یک راهنمای قالب‌بندی مستندات برای همه رشته‌های اسناد در پایگاه کد ایجاد می‌کنم تا دنبال شوند. کار من روی این پروژه همچنین شامل پیاده‌سازی راهنمای جدید برای به‌روزرسانی رشته‌های اسناد موجود، در عین جمع‌آوری و رسیدگی به تناقضات دیگر مانند استفاده از زبان یا اصطلاحات است. من و مربیانم با هم تصمیمات سرمقاله ای را در مورد نحوه رسیدگی به این تناقضات اضافی می گیریم، و ترجیحات سبکی ناشی از آن نیز به راهنما اضافه می شود.
هدف نهایی این پروژه یک راهنمای قالب بندی اسناد و سبک است که می تواند توسط توسعه دهندگان و مشارکت کنندگان برای کمک به حفظ ثبات در رشته های اسناد SymPy در حال حاضر و در آینده استفاده شود.