پروژه تریتون

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

خلاصه ی پروژه

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

تریتون

نویسنده فنی:

دیو

نام پروژه:

مستندات برای ماژول های پایه

طول پروژه:

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

شرح پروژه

در این پروژه من پیشنهاد می‌کنم مستندات ماژول‌های اصلی Tryton را بررسی و به‌روزرسانی کنیم. اینها ماژول هایی هستند که افراد معمولاً هنگام راه اندازی یک سیستم Tryton باید آنها را فعال کنند.

بهبود مستندات ماژول Tryton به کاربران کمک می کند تا ماژول های مناسب برای نیازهای خود را پیدا کنند و سپس به آنها کمک می کند تا سیستم خود را راه اندازی و استفاده کنند. مستندات خوب ماژول به کاربران این امکان را می دهد که پاسخ برخی از سؤالات اساسی خود را بدون نیاز به منتظر ماندن برای پاسخ در انجمن گفتگو بیابند.

ماژول های اصلی حداقل شامل موارد زیر است: حساب، حساب_فاکتور، حساب_فاکتور_ سهام، حساب_محصول، شرکت، کشور، ارز، حزب، محصول، خرید، فروش و ماژول های سهام.

سه مخاطب اصلی برای اسناد Tryton، کاربران، مدیران سیستم و توسعه دهندگان وجود دارد. برای کمک به هدف قرار دادن اسناد به هر یک از این موارد، پیشنهاد می‌کنم که اسناد هر ماژول به فایل‌های جداگانه در داخل دایرکتوری doc تقسیم شود. این موارد می تواند شامل فایل های حاوی فهرست مطالب و توضیحات ماژول، دستورالعمل های راه اندازی ماژول، اطلاعاتی در مورد نحوه استفاده از ماژول و جزئیاتی در مورد طراحی و ساختار ماژول باشد. بسته به عملکرد ماژول ممکن است برخی از این فایل ها مورد نیاز نباشند، و در صورت نیاز می توان فایل های اضافی ایجاد کرد. بهبودهای ماژول مطابق با مواردی است که قبلاً برای ماژول مهمانی پیشنهاد داده ام: https://codereview.tryton.org/297241003/#ps327231002

ساختار اسناد به این شکل به خوبی کار خواهد کرد زیرا اسناد در حال حاضر توسط Sphinx با استفاده از فایل‌های reStructuredText تولید می‌شوند. همانطور که من تغییراتی در اسناد ایجاد می کنم، آنها در سایت بررسی کد Tryton آپلود می شوند، بنابراین می توان آنها را بررسی کرد، و من می توانم آنها را در صورت نیاز به روز کنم. به محض اینکه همه از آنها راضی باشند، امیدواریم بتوانند برای گنجاندن در Tryton تأیید شوند.