این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- برگ
- نویسنده فنی:
- گالینیتا
- نام پروژه:
- گسترش مستندات کاربر نهایی برنامه های FOLIO
- طول پروژه:
- دویدن طولانی مدت (5 ماه)
شرح پروژه
برای این پروژه، من قصد دارم بر روی ایجاد و به روز رسانی اسناد FOLIO با هدف کاربر نهایی کار کنم. از آنجایی که FOLIO یک سیستم مدیریت کتابخانه است، کاربر نهایی کارکنان کتابخانه هستند. در حال حاضر، ویکی FOLIO (https://wiki.folio.org/) حاوی برخی اسناد است، اما حداقل است و در قالبی قابل هضم نیست که با در نظر گرفتن کارکنان کتابخانه ایجاد شده باشد. اسناد جدید ایجاد شده از این پروژه بر روی یک پایگاه دانش مستندات خاص میزبانی می‌شود که از برنامه‌های FOLIO قابل دسترسی است و شامل گردش‌های کاری مربوط به سیستم و کاربران کتابخانه آن است. مجموعه اولیه مستندات در سایت منتشر خواهد شد که با عملکرد گردش و ذخیره دوره شروع می شود. من می خواهم تا آنجا که می توانم در مستندسازی در طول این پروژه "طولانی" مشارکت کنم.
در بررسی پروژه مستندسازی FOLIO، با Marcia Borensztajn در مورد نیازهای FOLIO و وضعیت اسناد فعلی صحبت کردم. همانطور که در بالا ذکر شد، اسناد FOLIO باید به روز شود، گسترش یابد و دوباره کار شود تا بتواند با موفقیت به کاربران خود کمک کند. مستندات باید ایجاد شوند تا فرآیندهای استاندارد کتابخانه را منعکس کنند و از آنجا که FOLIO از «برنامه‌های» مختلفی تشکیل شده است که با هم کار می‌کنند، سیستم باید به عنوان یک کل توضیح داده شود. از آنجایی که من یک کتابدار هستم، با انواع سناریوها و گردش کار که کاربران FOLIO احتمالاً از آن عبور می کنند و به کمک نیاز دارند، بسیار آشنا هستم. مارسیا در حال کار بر روی ایجاد پایگاه دانش مستندات جدید با استفاده از markdown، Git و Hugo است. از این پروژه، مستندات جدیدی در مورد FOLIO ایجاد خواهد شد و به عنوان چارچوبی برای آینده عمل خواهد کرد.