در حال حاضر راهنمای بسته bidi دارای ۶۰۴ صفحه و راهنمای بسته xepersian دارای ۲۰۳ صفحه است. تعداد زیاد صفحات راهنمای دو بسته، بسیاری از کاربران را وحشتزده میکند که مجبور باشند این همه زمان صرف راهنما کنند.
متأسفانه این ذهنیت در واقعیت درست نیست زیرا که بخش راهنمای کاربری دو بسته کوتاه است و آنچه که هست بیشتر کد خود بستهها است.
من در GitHub برای هر دو بسته راهنما را به دو راهنما جداگانه تقسیم کردهام:
Source documentation (فایلهای bidi.pdf و xepersian.pdf)User documentation (فایلهای bidi-doc.pdf و xepersian-doc.pdf)
بنابراین کاربری که تنها میخواهد نحوه استفاده از دو بسته را بداند فقط نیاز دارد User documentation را بخواند و کاربری که میخواهد توضیح کدهای داخلی هر دو بسته و اینکه چگونه به عنوان مثال محیط tabular تغییر یافته است تا بتوان جدول با ستونهای راست به چپ حروفچینی کرد میتواند Source documentation را بخواند.
توجه کنید که Source documentation مناسب همه کاربران نیست و شاید کاربران خیلی کمی باشند که علاقهمند باشند آن را بخوانند.
من از فردا روی Source documentation و User documentation کار خواهم کرد و آنها را بروز خواهم کرد. برای این کار باید همه فایلهای دو بسته را بخوانم که خوبیاش این است که اگر کد قدیمی در این بین وجود دارد میتوانم آن را هم بروز کنم.
بروز کردن راهنماها پروسه وقتگیری است به همین دلیل نمیدانم کمی تمام میشود اما کاربرانی که علاقهمند هستند میتوانند GitHub را چک کنند و چنانچه مطلبی در راهنماها وجود دارد که چندان روشن نیست و یا اگر نظرات یا پیشنهادات دیگری دارند به من اطلاع بدهند.
