پروژه Sympy
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- SymPy
- نویسنده فنی:
- با کمال میل
- نام پروژه:
- سازگاری بین رشتههای اسنادی
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
برای این پروژه، هدف من ایجاد سازگاری بیشتر با رشتههای مستند SymPy است.
با کار با مربیانم، ابتدا قالب بندی مورد نظر را برای یک رشته مستند در پایگاه کد شناسایی می کنم. سپس یک راهنمای قالببندی مستندات برای همه رشتههای اسناد در پایگاه کد ایجاد میکنم تا دنبال شوند. کار من روی این پروژه همچنین شامل پیادهسازی راهنمای جدید برای بهروزرسانی رشتههای اسناد موجود، در عین جمعآوری و رسیدگی به تناقضات دیگر مانند استفاده از زبان یا اصطلاحات است. من و مربیانم با هم تصمیمات سرمقاله ای را در مورد نحوه رسیدگی به این تناقضات اضافی می گیریم، و ترجیحات سبکی ناشی از آن نیز به راهنما اضافه می شود.
هدف نهایی این پروژه یک راهنمای قالب بندی اسناد و سبک است که می تواند توسط توسعه دهندگان و مشارکت کنندگان برای کمک به حفظ ثبات در رشته های اسناد SymPy در حال حاضر و در آینده استفاده شود.
محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است، مگر غیر از این ذکر شده باشد. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی."],[[["This project focuses on improving the consistency of docstrings within the SymPy codebase."],["A documentation formatting and style guide will be created and implemented to standardize docstrings."],["The guide will address inconsistencies in formatting, language, and terminology for developers and contributors."],["The project is part of Google Season of Docs and will be completed over three months."]]],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]