نوشتن داکیومنت‌ها

[Sinusealpha]

تعدادی داکیومنت نیاز است که نوشته شود:

• داکیومنت اصول مشارکت در پروژه‌ی منبع‌باز مدیکس
• داکیومنت اصول تولید محتوا در پلتفرم مدیکس

ایده‌ای که دارم این هست که این مطالب هم به صورت منبع باز نوشته و قابل ویرایش باشند تا هرکسی نظری راجع بهشون داشت بتونه مطرح کنه.

[Sinusealpha]

خب من شروع به نوشتن این داکیومنت‌ها کردم. یه سند برای نحوه‌ی مشارکت نوشتم و یه سند هم برای چرایی مشارکت. البته هنوز اول کار ام و خیلی تکمیل نشده‌اند. اما هدف از هر کدوم از اسناد متفاوته و به شرح زیر هستش:

• سند چگونگی: پاسخ به این سوال که «منی که می‌خوام مشارکت کنم چطوری این کار رو بکنم؟»
• سند چرایی: پاسخ به این سوال که «اصن چرا باید مشارکت کنم و فایده‌اش چیه؟» (یک‌جور فرهنگ‌سازی هم محسوب می‌شه این سند)

درمورد سند تولید محتوا هنوز کاری انجام نداده‌ام و به زودی اون رو هم آغاز می‌کنم.

اگر نظری دارید بفرمایید. @aref-asadi @hossein-kazzemi

[Sinusealpha]

این هم لینک سند‌هایی هست که فعلا در حال کار بر روی اون‌ها هستم:

• سند راهنمای مشارکت انگلیسی: https://github.com/Sinusealpha/MedX/blob/main/contribution-guide
• سند راهنمای مشارکت فارسی: https://docs.google.com/document/d/1MqN3kFYmRMHa3mB40iO6MYB1kc_zbUaMOvsouq6bRU0/edit?usp=sharing
• سند چرایی انگلیسی: https://github.com/Sinusealpha/MedX/blob/main/CONTRIBUTION-WHY.md
• سند چرایی فارسی: https://docs.google.com/document/d/162J7WSJYWBKjr-eFsJ9tVCDSRQEnMXDkAL17bjYDyeA/edit?usp=sharing

اولویت این هست که هر سندی به هر دو زبان فارسی و انگلیسی وجود داشته باشه و یکسان هم باشه. البته چون فرهنگ‌ها یه کمی فرق می‌کنه تغییرات اندکی در نحوه‌ی بیان ما توی هر کدوم از سندها وجود داره و ترجمه‌ی محض نیست. اما اگر قرار باشه زبان دیگری رو هم در آینده اضافه کنیم به سمت ترجمه‌شدن حرکت می‌کنیم و نه نوشتن اون سند از ابتدا.

یه موضوع دیگه‌ای هم هست و اونم اینه که من سندهای فارسی رو توی گوگل‌داک قرار دادم و سندهای انگلیسی رو این‌جا. اول هر سند انگلیسی هم لینک به ورژن فارسی‌اش دادم و بنظرم این‌طوری خوب باشه. اگر راه بهتری به نظرتون می‌رسه لطفا بگید. @aref-asadi @hossein-kazzemi

[Sinusealpha]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

[aref-asadi]

با سلام من سند پیشنهادی چرایی مشارکت را در branch خودم نوشتم: CONTRIBUTION-WHY.md در صورتی که موافق باشی میتونی از این سند استفاده کنی.

[aref-asadi]

با سلام من سند پیشنهادی چگونگی مشارکت را در branch خودم نوشتم: CONTRIBUTION-GUIDE.md در صورتی که موافق باشی میتونی از این سند استفاده کنی.

[aref-asadi]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

[aref-asadi]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

در ضمن پیشنهاد می‌کنم تمامی مکالمات و پیام‌ها، اسناد و... نیز از این قالب پیروی کنند تا حتی افراد غیر انگلیسی و فارسی زبان نیز بتوانند مشارکت داشته باشند.

[Sinusealpha]

با سلام من سند پیشنهادی چرایی مشارکت را در branch خودم نوشتم: CONTRIBUTION-WHY.md در صورتی که موافق باشی میتونی از این سند استفاده کنی.

خیلی عالی بود عارف. دیدمش. دقیق‌تر بررسی‌اش می‌کنم و بر پایه‌ی همون سند اصلی رو هم تنظیم می‌کنم. دمت گرم.

[Sinusealpha]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

من هم موافقم باهات. همه‌ی اسناد اصلی باید در قالب انگلیسی نوشته بشوند و اگر لازم شد نسخه‌ی فارسی اون‌ها هم تهیه بشه تا بچه‌هایی که با فارسی راحت‌ترند هم مشکلی از این بابت نداشته باشند. ولی خب همین فارسی نوشتن‌های ما هم عملا نصف‌اش انگلیسیه و ذات کار همین شکلیه.

[aref-asadi]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

من هم موافقم باهات. همه‌ی اسناد اصلی باید در قالب انگلیسی نوشته بشوند و اگر لازم شد نسخه‌ی فارسی اون‌ها هم تهیه بشه تا بچه‌هایی که با فارسی راحت‌ترند هم مشکلی از این بابت نداشته باشند. ولی خب همین فارسی نوشتن‌های ما هم عملا نصف‌اش انگلیسیه و ذات کار همین شکلیه.

متوجه هستم. اما علت این پیشنهاد من این بود که ما بتوانیم از همه ظرفیت‌ها استفاده کنیم. اتفاقا خوب است که خود ما فارسی را بلد هستیم و با ترجمه کردن داکیومنت‌های انگلیسی به فارسی می‌توانیم کیفیت داکیومنت انگلیسی را ارزیابی کنیم. و اگر به بهترین نحو ممکن داکیومنت انگلیسی را نگارش کنیم همه افراد از همه جای دنیا با هر زبانی و هر سطحی از دانش انگلیسی می‌تواند به ما کمک کند.

[Sinusealpha]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

در ضمن پیشنهاد می‌کنم تمامی مکالمات و پیام‌ها، اسناد و... نیز از این قالب پیروی کنند تا حتی افراد غیر انگلیسی و فارسی زبان نیز بتوانند مشارکت داشته باشند.

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

در این مورد نیز نظر من این است که تا جایی که ممکن می‌باشد واضح، شفاف و ساده اسناد را به زبان انگلیسی بنویسیم تا در صورت استفاده از نرم‌افزارهای ترجمه، به راحتی و به هر زبانی قابل ترجمه و قابل فهم باشند.

من هم موافقم باهات. همه‌ی اسناد اصلی باید در قالب انگلیسی نوشته بشوند و اگر لازم شد نسخه‌ی فارسی اون‌ها هم تهیه بشه تا بچه‌هایی که با فارسی راحت‌ترند هم مشکلی از این بابت نداشته باشند. ولی خب همین فارسی نوشتن‌های ما هم عملا نصف‌اش انگلیسیه و ذات کار همین شکلیه.

متوجه هستم. اما علت این پیشنهاد من این بود که ما بتوانیم از همه ظرفیت‌ها استفاده کنیم. اتفاقا خوب است که خود ما فارسی را بلد هستیم و با ترجمه کردن داکیومنت‌های انگلیسی به فارسی می‌توانیم کیفیت داکیومنت انگلیسی را ارزیابی کنیم. و اگر به بهترین نحو ممکن داکیومنت انگلیسی را نگارش کنیم همه افراد از همه جای دنیا با هر زبانی و هر سطحی از دانش انگلیسی می‌تواند به ما کمک کند.

کاملا درست میگی. من هم بالاتر گفتم که موافقم. حتما این کار رو میکنیم.

[hossein-kazzemi]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

با سلام. بله به نظر من نسخه فارسی خیلی خوبه. هر چقدر هم با زبان انگلیسی راحت باشیم برای خود من به شخصه فارسی روان تر و بهتره. ممنون

[aref-asadi]

در ضمن بنظرتون لازم هست که README.md هم نسخه‌ی فارسی داشته باشه؟ به نظر خودم لازمه. اینم بگید بی‌زحمت @aref-asadi @hossein-kazzemi

با سلام. بله به نظر من نسخه فارسی خیلی خوبه. هر چقدر هم با زبان انگلیسی راحت باشیم برای خود من به شخصه فارسی روان تر و بهتره. ممنون

به نظر من اینکه دو زبانه بنویسیم ممکن هست باعث شود از کیفیت زبان انگلیسی کاسته شود یا غافل شویم.

در حال حاضر فکر میکنم این یک فرصت است که خودمان را هم بیشتر با زبان انگلیسی درگیر کنیم و سعی کنیم تمامی اهداف و منظور خودمان را به زبان انگلیسی منتقل کنیم. این مورد با اوپن سورس بودن ما نیز هم خوانی بیشتری دارد.

اما اگر بخشی فارسی و بخشی انگلیسی باشد ممکن است برای مشارکت‌کننده‌ها کمی اذیت‌کننده باشد.

به هر حال با مشاهده موارد مشابه اوپن سورس به نظر من رسید که یک زبان واحد و انگلیسی به طور ساده و واضح داشته باشیم هم از نظر اوپن سورس بودن و برقراری ارتباط با مشارکت‌کننده‌های دیگر و هم از لحاظ بیان هر چه بهتر منظور خود ما نیز کمک خواهد کرد.

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