مشروع لمحة عن الرمز

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.

ملخص المشروع

مؤسسة البرامج المفتوحة المصدر:
AboutCode
الكاتب الفني:
أيانسيها
اسم المشروع:
مرجع حول "خيارات سطر الأوامر" في مجموعة Recancode- كثيرًا، وأعِد تنظيم بنية مستندات aboutCode على الرابط aboutcode.readthedocs.io
طول المشروع:
المدة العادية (3 أشهر)

وصف المشروع

[ 1- خيارات سطر الأوامر Scancode-Toolkit ]

يتضمن Scancode-Toolkit مجموعة من خيارات "سطر الأوامر" لتخصيص كيفية إجراء الفحص وتنسيق الإخراج والعديد من الخيارات الأخرى مثل المكوّنات الإضافية التي تلي الفحص. لا تشمل هذه الخيارات حاليًا مستندات مناسبة لشرحها، وهي متاحة فقط من خلال العلامة " --help" أو " -h". يهدف هذا المشروع إلى تقديم وثائق كاملة تشرح ما يلي:

[ 1- جميع الخيارات المتاحة من خلال سطر الأوامر ]

  • الهدف: قائمة شاملة بكل الخيارات الممكنة عبر سطر الأوامر.
  • نظرة عامة أساسية: أولاً، تتم مناقشة خيارات البحث الافتراضية، مع مثال على المخرجات. رسم/وصف قصير حول كيفية إجراء المسح الضوئي
    بعد ذلك، يكون هذا السلوك التلقائي كمرجع لكيفية تغيير الخيارات الأخرى لعملية الفحص والنتيجة.
    ستتم مناقشة هذه العناصر بالتفصيل وستتضمّن المعلومات التالية كما هو موضّح في الأقسام التالية.

[ 2- بدء بنية تحديد الإصدارات ]

  • الهدف: بدء نظام تحديد إصدارات للحفاظ على خيارات الإصدار المتقاطع/واجهة برمجة التطبيقات وتغييرات التوثيق بشكل صحيح.
  • المشكلة: في الوقت الحالي، الوثائق الموجودة في موقع wiki وصفحات ReadThe Docs مخصصة للإصدارات الأقدم ويحتاج إلى إعادة هيكلة كبيرة.
  • نظرة عامة أساسية: أجزاء مجموعة أدوات مسح رمز المسح الضوئي التي تم تحديثها/يمكن تحديثها في الإصدار
  • خيارات سطر الأوامر
  • واجهات برمجة التطبيقات
  • الوثائق (سيتم البدء) يتم تغيير خيارات سطر الأوامر وواجهات برمجة التطبيقات في الإصدارات والإصدارات، ويجب أن تتّبع الوثائق أيضًا هذه الخطوات، وإلا ستؤدي إلى إرباك المستخدمين على نطاق واسع. تم تحديث أداة سطر الأوامر [ --help ] من قبل لأي تغييرات في الخيارات ويمكن استخدامها لنسخ الإصدارات في الوثائق.

[ 3- كيفية استخدام هذه الخيارات في حالات مختلفة ]

  • الهدف: سيقدم هذا القسم ملخصًا أساسيًا حول كيفية استخدام نتائج فحص مجموعة أدوات المسح الضوئي لأسباب مختلفة بالإضافة إلى خيارات مجموعة أدوات المسح الضوئي التي توفر هذه الوظيفة.
  • نظرة عامة أساسية: يمنحك هذا القسم أمثلة مختلفة على سيناريوهات حالة الاستخدام والخيارات المقترحة في هذه السيناريوهات.
  • ملاحظة: يتطلب هذا الجزء مساعدة كبيرة من الموجه من حيث المدخلات حول حالات الاستخدام المختلفة لـ Scancode-Toolkit والمؤشرات الخاصة بها.

[ 4- ما الذي تغيره هذه الخيارات في المسح والإخراج ]

  • الهدف: سيقدم هذا القسم ملخصًا أساسيًا حول كيفية استخدام نتائج فحص مجموعة أدوات مسح رمز المسح الضوئي لأسباب مختلفة، وسيقدم لك أدوات حول كود المعلومات (Aboutcode) التي توفر هذه الوظيفة.
  • نظرة عامة أساسية: تتيح لك الخيارات تغيير طريقة إجراء الفحص. سيتم توضيح حالة الأحرف الافتراضية الأساسية في القسم الأول [ 1. جميع الخيارات المتاحة من خلال سطر الأوامر ] وسيقارن هذا القسم التغييرات التي تجلبها جميع الخيارات إلى هذا السيناريو الافتراضي.

[ 5- تنسيقات الإخراج وأمثلةها ]

  • الهدف: سيقدم هذا القسم ملخصًا أساسيًا حول كيفية استخدام نتائج فحص مجموعة أدوات مسح رمز المسح الضوئي لأسباب مختلفة، وسيقدم لك أدوات حول كود المعلومات (Aboutcode) التي توفر هذه الوظيفة.
  • نظرة عامة أساسية: يحتوي Scancode-Tool على علامات لتحديد تنسيقات مخرجات مختلفة سيتم إنشاء نتائج الفحص بها. وهي -
    هذا الجزء
  • واشرح بالتفصيل تنسيقات الإخراج
  • إعطاء أمثلة حول تنسيقات الإخراج
  • لتقديم روابط أخرى تتوافق مع تنسيق الإخراج واستخدامه
  • كيفية تخزين نتائج الفحص في ملفات الإخراج. يرتبط هذا أيضًا بكيفية إنشاء هذه التنسيقات المختلفة، وسيتم شرحه في [ 2. مناقشات تشرح فحص التعليمة البرمجية ].

[ 6- استخدام الأعمال لتنسيقات إخراج Scancode ]

  • الأهداف: شرح حالات استخدام الأعمال لتنسيقات إخراج Scancode في قائمة أفكار GSoD، تتم الإشارة إلى تنسيقات ناتج Scancode كفكرة مرجعية. ويُنفِّذ هذا القسم الطريقة نفسها.
  • ملاحظة: يتطلب هذا الجزء مساعدة كبيرة من المرشد من حيث المدخلات والمؤشرات حول حالات استخدام الأعمال المختلفة لمجموعة أدوات Scancode-Toolkit.

[ 7- كيفية استخدام هذه المخرجات بواسطة مشاريع aboutCode الأخرى لإجراء مزيد من التحليل ]

  • الهدف: سيقدم هذا القسم ملخصًا أساسيًا حول كيفية استخدام نتائج فحص مجموعة أدوات مسح رمز المسح الضوئي لأسباب مختلفة، وسيقدم لك أدوات حول كود المعلومات (Aboutcode) التي توفر هذه الوظيفة.
  • نظرة عامة أساسية:
  • المسح الضوئي-العمل سنضيف الوثائق المطلوبة لمسح التعليمات البرمجية-workbench إذا لزم الأمر.
  • Deltacode كيف يتم الحصول على نتائج رمز المسح الضوئي بواسطة Deltacode لتحديد الاختلافات في مستوى الملف بين قاعدتَي رموز برمجية.

[ 2- إعادة تنظيم بنية وثائق aboutCode ]

يتضمن هذا الجزء مجموعة من التغييرات في وثائق aboutcode

[ 1- نظام تحديد الإصدارات ]

في [ 1. خيارات سطر الأوامر Scancode-Toolkit -> 2. بدء هيكل تحديد الإصدارات] تم ذكر مشكلة تحديد إصدارات خيارات سطر الأوامر. وينطبق الشيء نفسه على الأجزاء الأخرى من المستندات التي تحتوي أيضًا على أوامر أو معلومات خاصة بالإصدار والتي من شأنها أن تسبب التباسًا.

[ 2- وضع معايير واختبارات التوثيق ]

تحتوي الوثائق بالفعل على اختبارات بشأن إنشاء Spinx (يقوم بإنشاء جميع الصفحات والتحقق من أخطاء بنية Sphinx طوال الوقت) وفحص الروابط (يتحقق من جميع الروابط إلى صفحات الويب الأخرى من الوثائق) باستخدام التكامل المستمر من خلال Travis-CI. (أضفتُه في طلب السحب رقم 17 هذا) تحتاج الآن إلى مزيد من عمليات التحقّق من المحتوى غير الآمن في النص المُعاد تنظيمه والمعايير الأخرى. ويمكن تحقيق ذلك باستخدام أداة إعادة هيكلة النصّ ولكن يحتاج إلى مزيد من الأبحاث وسيتم إجراؤه كجزء من مشروع GSoD الخاص بي.

[ 3- إضافة قسم "البدء" ]

سيكون هذا بمثابة قسم البداية للمستخدمين الجدد وسيحتوي على مجموعة من المستندات الأساسية والمهمة للبدء في مشاريع لمحة عن كود. سيحتوي كل مشروع aboutcode على هذا القسم بما في ذلك Scancode-Toolkit، وScancode-Workbench، وdeltacode، وغيرها.

[ 4- إعادة الهيكلة وفقًا لدوال المستند الأربع ]

لم يتم تنظيم الوثائق الحالية بشكل صريح في دوال المستند الأربع - البرامج التعليمية، وطرق التنفيذ، والمراجع، والتفسيرات. أقترح تنظيم هذه العمليات وفقًا لذلك، وإضافة المزيد من المعلومات/التفسيرات/المؤشرات حسب الضرورة. ينطبق هذا الأمر على جميع مشاريعAboutCode ووثائقها. فيما يلي مثالان على وثائق Scancode-Toolkit التي أقترحها وأريد الاستمرار في هذا المشروع بها. سيتم إجراء تغييرات مماثلة على باقي الوثائق.

[ 5- إعادة هيكلة صفحة التطوير (Scancode-Toolkit) ]

يمكن إضافة مزيد من المعلومات حول الرموز البرمجية أو واجهات برمجة التطبيقات لجعلها أكثر ملاءمةً للمطوّرين. يمكن أن تكون هناك روابط إلى [ 2. مناقشات تشرح قسم مسح التعليمة البرمجية ] أعلاه. يربط هذا شرح كيفية عمل المسح بالرمز الذي يستخدمه لإجراء الفحص. ومثلما تحتوي هذه المجلدات على أجزاء مختلفة من مجموعة أدوات مسح رمز المسح الضوئي، يمكن توضيح استخدامها الفردي من خلال واجهات برمجة التطبيقات، جنبًا إلى جنب مع مناقشة حول كيفية عمل رمز المسح الضوئي.

  • [ cluecode : مكوّنات إضافية لفحص التراخيص وحقوق الطبع والنشر وعناوين URL ورسائل البريد الإلكتروني ]
  • [ الرمز المشترك : الفئات والدوال المساعدة]
  • [ استخراج الرمز : يستخرج تنسيقات أرشيف مختلفة ]
  • [ترميز منسق : تنسيق الإخراج لمختلف تنسيقات ملفات الإخراج ]
  • [ رمز الترخيص : رمز اكتشاف الترخيص ]
  • [ الكود الحزمة : تحليل تنسيقات الحزم المختلفة ]
  • [ تعليمات برمجية للمكوّن الإضافي : فئات لبنية المكونات الإضافية ]
  • [ رمز الملخص : يلخص عملية الفحص على التراخيص التي تم اكتشافها ]
  • [ الرمز النصي : يعالج تحليل النص ]
  • [ typecode : يعالج تحديدات نوع الملف ]
  • [ Scannercode : CLI وواجهة برمجة التطبيقات لمسح الرمز ضوئيًا، الجزء الأساسي ]

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

[ 6- إعادة هيكلة صفحة الأسئلة الشائعة (Scancode-Toolkit) ]

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

  • كيف يعمل ScanCode؟ تمت الإشارة إلى هذه المشكلة في [ 2. المناقشات التي تشرح عملية مسح التعليمة البرمجية ] وستكون قسمًا منفصلاً تمامًا بمزيد من التفاصيل.
  • كيف يمكن إضافة قواعد ترخيص جديدة لميزة الرصد المحسَّنة؟ تمت مناقشة هذه المشكلة من قبل في قسم "تحسين طريقة التنفيذ" الحالية، وسيتم نقل الوثائق إلى هناك.
  • كيف يمكن إضافة قاعدة جديدة لرصد التراخيص؟ يمكن إجراء ذلك في منشور آخر "كيفية تنفيذ" بشكل منفصل ويمكن شرحه بالتفصيل.
  • كيف تبدأ بالتطوير؟ هناك بالفعل صفحة تطوير منفصلة والمعلومات تتداخل كثيرًا. سبق أن تمت مناقشة إعادة هيكلة صفحة التطوير أعلاه.
  • خطوات قص إصدار جديد يمكن تحويلها إلى فيديو منفصل بعنوان "كيفية إزالة إصدار جديد".
  • اعثر على المزيد من أسئلة الأسئلة الشائعة التي تجيب عن الأسئلة العامة حول المشروع ولا تندرج ضمن فئتي "How To"/"tutorial".