این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- LibreOffice
- نویسنده فنی:
- کرژایرو
- نام پروژه:
- مرجع توابع کالک و راهنمای کاربر
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
درخواست پروژه
من به راحتی می توانم 30 تا 35 ساعت در هفته را در مرحله نگارش فنی و 10 تا 12 ساعت را در مرحله پیش نوشتن برای یادگیری مهارت های مورد نیاز پروژه اختصاص دهم. به اطلاع شما می‌رسانم که در حال حاضر در دانشگاه خود (در کشور خود) زندگی می‌کنم که به اینترنت پرسرعت و هر منبع افزودنی مورد نیاز برای پروژه دسترسی دارم و از خود دانشگاه برای کل مدت پروژه ادامه خواهم داد. ما در شرایط کووید-19 هستیم، من نمی بینم دانشگاه من به این زودی شروع شود و حتی اگر شروع شود، در سال آخر هستم که قرار است فقط 5-6 ساعت در هفته در کلاس ها شرکت کنم، بنابراین این کار را نمی کند. به هر نحوی پروژه را تحت تاثیر قرار دهد.
معرفی
LibreOffice Calc دارای یک لیست گسترده (+ 500) از توابع در دسته بندی های بسیاری است که مستندات آنها در راهنما کاملاً کم عمق (اما با این وجود دقیق) است. جادوگر توابع داخلی Calc همچنین اطلاعات خلاصه ای در مورد هدف و پارامترهای هر تابع در اختیار کاربر قرار می دهد. ساختاری در ویکی The Document Foundation ایجاد شده است تا اطلاعات مرجع دقیق تری در مورد عملکردهای Calc دریافت کند.
هدف، واقعگرایانه
برای تکمیل ساختار ویکی با نوشتن مطالب دقیق‌تر برای هر یک از توابع Calc، پرچم‌گذاری پایبندی به استاندارد ODFF، از جمله تصاویر و نمودارها مفید بود، با ارائه یک یا دو مثال برای نشان دادن موارد گوشه‌ای و استثناها و ارائه فایل‌های نمونه/مثال.
طرح کار پروژه
من به طور کامل ایده اصلی پروژه را دنبال کرده‌ام و اساساً سعی می‌کنیم کار هر تابع را در جادوگر توابع و همراه با مثال‌های کافی برای هر یک که تمام جنبه‌های عملکردها را پوشش می‌دهد مستند کنیم و سعی می‌کنیم مستندات را تا حد امکان بصری کنیم تا یک کاربر جدید می تواند جستجو کند و در عرض چند ثانیه بفهمد که چگونه از آن استفاده کند.
من می خواهم این توابع را بر اساس دسته ها تقسیم کنم:
• Database: This section deals with functions used with data organized as one row of data for one record.
• Date & Time: These spreadsheet functions are used for inserting and editing dates and times.
• Financial: This category contains the mathematical finance functions of LibreOffice Calc.
• Information: This category contains Information functions.
• Logical: This category contains Logical functions.
• Mathematical: This category contains the Mathematical functions for Calc.
• Array: This category contains the array functions.
• Statistical: This category contains Statistics functions.
• Spreadsheet: This section contains descriptions of the Spreadsheet functions together with an example.
• Text: This section contains descriptions of the Text functions.
• Add-in: The following describes and lists some of the available add-in functions.
هر کدام حدود 20 تا 50 عملکرد دارد که تعداد کمی از آنها بیشتر است. اکثر آنها شامل یک توصیف کم عمق با نحو و یک مثال هستند.
می‌خواهم مطالب دقیق‌تری را برای هر یک از توابع Calc اضافه کنم، پایبندی به استاندارد ODFF را علامت‌گذاری کنم، از جمله تصاویر و نمودارها در هر کجا که مفید باشد، ارائه یک یا دو مثال برای نشان دادن موارد گوشه‌ای و استثناها در قالب اظهارات، و ارائه فایل‌های نمونه/مثال . همچنین افزودن یک بخش مهم در هر کجا که مفید باشد. من این توابع را در قالب دسته‌بندی بررسی می‌کنم، یعنی یکی را انتخاب کرده و به صورت عمودی کار می‌کنم و سپس در طول دوره نگارش فنی به مقوله دیگری می‌روم. علاوه بر این، عادت کردن به محیط کار در طول دوره پیوند جامعه را در نظر دارم تا کارها را در مرحله نوشتن آسانتر کنم. در تجربه من، کشف تمام لحظات کوچک ""گوچا!"" مستندسازی این نوع برنامه ها نیاز به سرمایه گذاری زمانی دارد. از نظر برنامه‌ریزی، در ابتدا با اجرای این ۱۱ دسته‌بندی به پروژه نزدیک می‌شوم تا روی آن کار کنم، البته، برخی به کمک بیشتری نیاز دارند و از این رو به زمان بیشتری نسبت به دیگران نیاز دارند، اما می‌توان به این موارد در حین کار پرداخت. از آنجایی که برخی اسناد از قبل موجود است و من در بالای آن می نویسم، پس از اتمام کار هر هفته، تصحیح را در نظر خواهم گرفت زیرا خوب نیست آن را برای هفته آخر رها کنیم.
بنابراین در زیر یک برنامه تقریبی برای سازماندهی پروژه در محدوده زمانی ارائه شده است.
- هفته 1: (14 سپتامبر) • پایگاه داده
- هفته 2: (21 سپتامبر) • تاریخ و زمان
- هفته 3: (28 سپتامبر) • مالی
- هفته 4: (05 اکتبر) • اطلاعات
- هفته 5: (12 اکتبر) • منطقی است
- هفته 6: (19 اکتبر) • ریاضی
- هفته 7: (26 اکتبر) • آرایه
- هفته 8: (2 نوامبر) • آماری
- هفته 9: (9 نوامبر) • صفحه گسترده
- هفته 10: (16 نوامبر) • متن
- هفته 11: (23 نوامبر) • افزودنی
- هفته 12: (30 نوامبر - 5 دسامبر) (نهایی)
مستندسازی کار انجام شده و تجربه به‌دست‌آمده از این پروژه و کار بر روی موارد جزئی شامل تصحیح خواندن/ویرایش پاس دوم در صورت نیاز برای آماده‌سازی مستندات برای ارسال بود.