كيفية توثيق البرمجيات بصيغة IEEE

فهم توثيق البرمجيات بصيغة IEEE

تُعد برامج البرمجيات والتطبيقات والرموز البرمجية مصادر متزايدة الأهمية في الأبحاث التقنية والعلمية. يساهم التوثيق الصحيح للبرمجيات في الاعتراف بجهود المطورين ويسمح للقراء بالوصول إلى نفس النسخة المستخدمة في البحث.

صيغة IEEE لتوثيق البرمجيات تتضمن معلومات عن المطور، اسم البرنامج، الإصدار، الناشر، السنة، ومعلومات توفر البرنامج. هذه الصيغة تناسب البرمجيات التجارية والأكاديمية والمفتوحة المصدر.

صيغة IEEE للبرمجيات

[#] المطورون، “اسم البرنامج”، الإصدار، الناشر، الشهر السنة، [عبر الإنترنت]. متاح على: URL.

مثال:

[1] J. K. Smith, “Advanced Computational Modeling Software,” ver. 3.2, Tech. Software Inc., Jun. 2023, [Online]. Available: https://www.techsoftware.com/acms.

عناصر التوثيق التفصيلية

المطور/المنشئ

قم بتضمين الشخص أو المنظمة التي أنشأت البرنامج.

اسم البرنامج

استخدم الاسم الرسمي للبرنامج.

الإصدار

قم بتضمين رقم الإصدار المستخدم في عملك.

الناشر

حدد الشركة أو المنظمة التي توزع البرنامج.

السنة

قم بتضمين سنة إصدار البرنامج.

الرابط أو المنصة

قم بتضمين المكان الذي يمكن الوصول فيه إلى البرنامج.

أمثلة تفصيلية

البرمجيات التجارية

[1] MathWorks, “MATLAB,” ver. R2023b, MathWorks, Sep. 2023, [Online]. Available: https://www.mathworks.com.

البرمجيات مفتوحة المصدر

[2] Python Software Foundation, “Python,” ver. 3.11, Open Source, 2023, [Online]. Available: https://www.python.org.

برمجيات البحث العلمي

[3] L. Chen and M. Garcia, “Molecular Dynamics Simulation Package,” ver. 2.5.1, [Online]. Available: https://github.com/research-group/mdsp. Accessed: Feb. 15, 2023.

حزمة برمجيات أكاديمية

[4] R Core Team, “R: A language and environment for statistical computing,” ver. 4.2.3, R Foundation for Statistical Computing, Vienna, Austria, 2023, [Online]. Available: https://www.r-project.org.

التوثيق داخل النص للبرمجيات

تستخدم IEEE التوثيق الرقمي بين قوسين مربعين:

تم إجراء المحاكاة باستخدام البرنامج [1].

أو عند الإشارة إلى عدة برامج:

تم استخدام برامج التحليل الإحصائي [2] وأدوات التصوير [3].

حالات خاصة في توثيق البرمجيات

برمجيات بمطور مؤسسي

[5] المركز الوطني لمعلومات التكنولوجيا الحيوية (NCBI), “BLAST – Basic Local Alignment Search Tool,” ver. 2.14, [Online]. Available: https://blast.ncbi.nlm.nih.gov. Accessed: Mar. 1, 2023.

برمجيات مرخصة

[6] مساهمو BlendSwap, “Blender,” ver. 3.4.1, رخصة GNU GPL, 2023, [Online]. Available: https://www.blender.org.

برمجيات بحثية مملوكة

[7] J. Williams, “Advanced Signal Processing Toolkit,” ver. 1.2, برمجيات مملوكة، 2023، [Online]. متاح عند الطلب من المؤلف.

برمجيات مستضافة على GitHub/مستودعات

[8] A. Martinez, “Deep Learning Image Classification Framework,” ver. 0.5.2, 2023, [Online]. Available: https://github.com/researcher/dlicf. Accessed: Mar. 10, 2023.

استخدام GenText لإدارة توثيق البرمجيات

يتطلب إدارة توثيق البرمجيات تتبع الإصدارات والمطورين ومعلومات التوفر. يساعد GenText في:

• تنسيق توثيق البرمجيات بأسلوب IEEE الصحيح
• تتبع إصدارات البرمجيات وتواريخ الإصدار
• إدارة روابط المستودعات ومعلومات الوصول
• التنظيم حسب المطور أو الترخيص أو المجال
• التحويل بين أنماط التوثيق
• إنشاء قوائم المراجع للمشاريع التقنية
• الحفاظ على معلومات تاريخ الإصدارات

الأخطاء الشائعة في توثيق البرمجيات

1. رقم الإصدار غير صحيح: يجب دائماً توثيق الإصدار المحدد المستخدم.
2. غياب معلومات المطور أو الناشر: تضمين النسب الصحيح.
3. روابط غير كاملة أو معطلة: تحقق من صلاحية جميع الروابط.
4. اسم البرنامج خاطئ: استخدم الاسم الرسمي كما هو.
5. حذف تاريخ الوصول للبرمجيات عبر الإنترنت: تضمين تاريخ الوصول ضروري للمصادر الإلكترونية.

قائمة التحقق لتوثيق البرمجيات

• اسم المطور أو الناشر صحيح
• اسم البرنامج دقيق
• رقم الإصدار محدد
• سنة الإصدار صحيحة
• الرابط كامل ويعمل
• المنصة أو طريقة التوزيع واضحة
• الترخيص مذكور (إن وجد)
• تاريخ الوصول مضمّن (للمصادر الإلكترونية)

كيفية العثور على معلومات البرمجيات

لجمع معلومات توثيق البرمجيات:

1. تحقق من قائمة “حول” أو “مساعدة” في البرنامج
2. راجع ملف README أو الوثائق
3. زر الموقع الرسمي أو المستودع
4. سجل رقم الإصدار وتاريخ الإصدار
5. دون معلومات المطور أو الناشر

فهم أنواع البرمجيات

لفئات البرمجيات اعتبارات خاصة:

• البرمجيات التجارية: مملوكة مع تراخيص
• البرمجيات مفتوحة المصدر: شفرة مجانية متاحة للجميع
• البرمجيات الأكاديمية: مطورة لأغراض البحث
• البرمجيات المجانية (Freeware): مجانية لكنها ليست مفتوحة المصدر
• أدوات البحث: متخصصة لمجالات معينة

تزداد أهمية البرمجيات كمساهمة بحثية تستحق التوثيق. يشجع التوثيق الصحيح على البحث القابل للتكرار ويعترف بمساهمات المطورين.

قراءة إضافية

• دليل توثيق IEEE — الدليل الرسمي من IEEE يقدم تعليمات مفصلة حول توثيق مصادر متنوعة بما فيها البرمجيات بصيغة IEEE.
• موقع Purdue OWL (مختبر الكتابة الإلكتروني) — يقدم موارد شاملة للكتابة وإرشادات التوثيق التي تساعد في توضيح معايير التوثيق عبر الصيغ المختلفة.
• أسلوب APA — رغم تركيزه على APA، يوفر هذا الموقع رؤى مفيدة حول توثيق البرمجيات والأدوات الرقمية التي تكمل فهم ممارسات توثيق IEEE.

قراءات إضافية

• IEEE Citation Reference — المرجع الأساسي لفهم أسلوب IEEE في التوثيق، بما في ذلك كيفية صياغة المراجع داخل النص وقائمة المصادر.
• IEEE Citation Reference — يوضح قواعد تنسيق المراجع للمصادر التقنية والبرمجيات بطريقة تتوافق مع متطلبات IEEE.
• IEEE Citation Reference — مفيد عند توثيق البرامج والتطبيقات والمواد الرقمية ضمن صيغة أكاديمية دقيقة.