پروژه جهانی موجا

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه ی پروژه

سازمان منبع باز:

موجا جهانی

نویسنده فنی:

آنتونی

نام پروژه:

مستندات کد ابزار گزارش

طول پروژه:

طول استاندارد (3 ماه)

شرح پروژه

با توجه به فرصت مستندسازی ابزار گزارش‌دهی برای سازمان جهانی Moja، من پیشنهاد می‌کنم 6 نوع مستندات را ایجاد کنیم که توسط مخاطبان مختلف برای دستیابی به اهداف مختلف مورد استفاده قرار گیرد. این موارد به طور خلاصه در زیر آمده است:

1) راهنمای تنظیم محیط

1.1) مهندسین سیستم مخاطبین هدف

1.2) مهندسان سیستم راهنمای هدف، یک محیط ساخت و اجرای محلی را برای ابزار گزارش دهی تنظیم می کنند.

1.3) قالب بندی یک مقاله نحوه انجام که مجموعه مراحل متوالی را که مهندسان سیستم باید برای راه اندازی محیطی که برای ساخت و اجرای ابزار گزارش دهی مساعد است، انجام دهند را تجویز می کند.

2) راهنمای ساخت

2.1) مهندسین سیستم مخاطب هدف

2.2) مهندسان سیستم به کمک هدف، اجزای ابزار گزارش را از کد منبع می‌سازند

2.3) قالب بندی مقاله نحوه انجام که مجموعه مراحل متوالی را که مهندسان سیستم باید برای به دست آوردن و کامپایل کد منبع ابزار گزارشگری انجام دهند، تجویز می کند.

3) راهنمای نصب

3.1) مهندسین سیستم مخاطبین هدف

3.2) هدف مهندسان سیستم به نصب اجزای ابزار گزارش دهی تازه ساخته شده کمک می کنند

3.3) قالب بندی مقاله نحوه انجام که مجموعه مراحل متوالی را که مهندسان سیستم باید برای استقرار ابزار گزارش در یک محیط تازه راه اندازی شده انجام دهند، تجویز می کند.

4) راهنمای عملیات

4.1) یکپارچه سازهای سیستم مخاطبین هدف

4.2) مهندسان سیستم راهنمای هدف، یک نمونه ابزار گزارش گیری تازه نصب شده را اجرا می کنند

4.3) قالب بندی مقاله نحوه انجام که مجموعه مراحل متوالی را که یکپارچه سازهای سیستم باید برای آپلود و پردازش پایگاه های داده خروجی Flux بر روی یک نمونه ابزار گزارش در حال اجرا انجام دهند، تجویز می کند.

راهنمای عملیات در داخل هواپیما و پردازش Flux Output Database در ابزار گزارش

5) راهنمای کاربر

5.1) مخاطبان هدف کاربران نهایی

5.2) راهنمای هدف کاربران نهایی ویژگی های مختلف تعبیه شده در ابزار گزارش دهی و نحوه استفاده از این ویژگی ها را درک می کنند.

5.3) قالب بندی مقاله نحوه انجام که مجموعه مراحل متوالی را که کاربران نهایی برای استفاده صحیح از عملکردهای ابزار گزارش باید انجام دهند، تجویز می کند.

6) راهنمای توسعه

6.1) برنامه نویسان مخاطب هدف

6.2) راهنمای هدف کاربران نهایی ویژگی های مختلف تعبیه شده در ابزار گزارش دهی و نحوه استفاده از این ویژگی ها را درک می کنند.

6.3) قالب بندی مقالات مرجع که شرح می دهند: الف) عناصر اصلی طراحی که ابزار را تشکیل می دهند ب) تجزیه عملکردی عناصر فوق ج) عناصر اجرایی عناصر تجزیه شده عملکردی د) کد منبع ابزار / سازمان کتابخانه ها ه) چشم انداز بلندمدت و جهت برای بهبود مستمر f) زمینه های منطقی بعدی برای بهبود

و یک آموزش کوتاه که نحوه تنظیم کد را با شرایط خاص کاربر توضیح می دهد