تنسيقات مفتوحة لتبادل البحوث

استخدم هذه الإرشادات مع معايير المساهمة المشتركة. استخدم التنسيقات التي يمكن للمتعاونين فحصها وتبادلها وإعادة استخدامها باستخدام الأدوات المتاحة بشكل شائع. ابدأ بالافتراضات أدناه واحتفظ بالمصدر الأصلي عندما يفقد التصدير المعنى العلمي أو قابلية التحرير.

مواد الافتراضي العملي
الملاحظات والبروتوكولات والوثائق UTF-8 ماركداون. تصدير PDF عندما تكون نسخة القراءة الثابتة مفيدة.
طاولات صغيرة UTF-8 CSV مع قاموس بيانات أو مخطط.
طاولات أكبر مطبوعة الباركيه مع القاموس والقارئ / نسخة المكتبة. تقديم مثال CSV صغير عندما تكون مفيدة.
السجلات المنظمة والتبادلات JSON؛ JSONL لسجل واحد لكل سطر. تضمين مخطط عندما تحتاج الحقول إلى التحقق من الصحة.
تهيئة محررة بشرياً YAML أو JSON ، مع النسخة المدعومة ومثال.
مراجع BibTeX أو RIS أو CSL JSON ، مع الاحتفاظ بـ DOI أو معرفات مستقرة أخرى.
الأشكال والرسوم البيانية المصدر القابل للتحرير و SVG حيثما كان ذلك مناسبًا ؛ PNG للصور النقطية و PDF للنسخ المطبوعة الثابتة.

CSV وحده لا يحافظ على أنواع الحقول أو يشرح ما تعنيه القيم. تسجيل تعاريف الأعمدة والأنواع والوحدات ورموز القيمة المفقودة وتنسيقات التواريخ والمناطق الزمنية والمعرفات والعلاقات بين الجداول. حافظ على المعرفات مع الأصفار الرائدة كسلاسل. القاموس القصير يكفي لجدول بسيط ؛ W3C CSV البيانات الوصفية يوفر خيار قابل للقراءة آليًا. باركيه يحافظ على الحقول المكتوبة ولكن لا يزال يحتاج إلى وصف لمعناها وأصلها.

استخدم تنسيقات النطاقات عندما تحافظ على البحث بشكل أفضل من الجدول العام. ومن الأمثلة على ذلك SBML أو CellML للنماذج البيولوجية المناسبة و FMI لتبادل النموذج المدعوم أو المشاركةsimulation..... يمكن أن يدعم NetCDF أو HDF5 المصفوفات العلمية المناسبة ، ويمكن أن تدعم STEP تبادل CAD. الحفاظ على النموذج الأصلي، ومدخلات حلال، وتنسيق النظم والوحدات والتبعيات، والإصدارات شكل اللازمة لتفسير أو إعادة تشغيله. تحقق من تصدير الصرف في أداة الاستلام قبل التعامل معها على أنها تعادل مصدرها.

حافظ على المصدر وتاريخه#

الاحتفاظ بمصادر قابلة للتحرير إلى جانب قراءة النسخ أو ربطها من خلال بيان صادر. تسجيل النسخة المصدر، البرنامج النصي التحول أو إعدادات التصدير، وإصدار البرمجيات، وأية معلومات فقدت. قد يظل جدول البيانات مصدر عمل قابل للتحرير. تصدير جداول التبادل والاحتفاظ الصيغ والتحولات اللازمة لإعادة إنتاجها. عادةً ما يكون ملف PDF أو لقطة الشاشة بمفرده غير كافٍ للبيانات القابلة لإعادة الاستخدام أو النموذج.

احتفظ بالمصادر الصغيرة والقابلة للمشاركة والمخططات والنصوص والبيانات الوصفية في Git. وضع القطع الأثرية الكبيرة والمواد المقيدة في التخزين الخارجي المناسب. تتبع بيانًا قابلًا للمشاركة يحتوي على معرفات القطع الأثرية والإصدارات والمواقع والسمات الاختبارية عند الاقتضاء والمصدر وشروط الوصول وتعليمات التجديد. الاحتفاظ بالمسارات السرية والبيانات الوصفية في السجل الخاضع للرقابة عند الضرورة.

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

عرض المصدر على GitHub