/ الدليل / الملعب / Codebase to Course
● مجتمع zarazhangrui ⚡ فوري

Codebase to Course

بواسطة zarazhangrui · zarazhangrui/codebase-to-course

أشِر إلى مستودع واحصل على 'دورة' HTML واحدة تشرحه كدرس تعليمي — كود مُعلَّق ومخططات وسرد — للمهندسين غير التقنيين والموظفين الجدد.

codebase-to-course هي مهارة Claude Code تتجوَّل عبر مستودع كامل وتنتج ملف HTML ذا ملف واحد يشرح كيفية عمل قاعدة الكود فعلاً. هي مُهيكَلة كدرس تعليمي: نظرة عامة على البنية، ثم تعمُّق لكل وحدة، ثم عرض 'تتبُّع هذا الطلب عبر النظام' — مع مقتطفات كود مُضمَّنة ومُعلَّقة. الناتج ملف HTML واحد، بلا خطوة بناء.

لماذا تستخدمه

الميزات الأساسية

عرض مباشر

كيف يبدو في الممارسة

جاهز

التثبيت

اختر العميل

~/Library/Application Support/Claude/claude_desktop_config.json  · Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

افتح Claude Desktop → Settings → Developer → Edit Config. أعد التشغيل بعد الحفظ.

~/.cursor/mcp.json · .cursor/mcp.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

يستخدم Cursor نفس مخطط mcpServers مثل Claude Desktop. إعدادات المشروع أولى من الإعدادات العامة.

VS Code → Cline → MCP Servers → Edit
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

انقر على أيقونة MCP Servers في شريط Cline الجانبي، ثم "Edit Configuration".

~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "codebase-to-course-skill": {
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ],
      "_inferred": true
    }
  }
}

نفس الصيغة مثل Claude Desktop. أعد تشغيل Windsurf لتطبيق التغييرات.

~/.continue/config.json
{
  "mcpServers": [
    {
      "name": "codebase-to-course-skill",
      "command": "git",
      "args": [
        "clone",
        "https://github.com/zarazhangrui/codebase-to-course",
        "~/.claude/skills/codebase-to-course"
      ]
    }
  ]
}

يستخدم Continue مصفوفة من كائنات الخادم بدلاً من خريطة.

~/.config/zed/settings.json
{
  "context_servers": {
    "codebase-to-course-skill": {
      "command": {
        "path": "git",
        "args": [
          "clone",
          "https://github.com/zarazhangrui/codebase-to-course",
          "~/.claude/skills/codebase-to-course"
        ]
      }
    }
  }
}

أضف إلى context_servers. يعيد Zed التحميل تلقائيًا عند الحفظ.

claude mcp add codebase-to-course-skill -- git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course

أمر من سطر واحد. تحقق باستخدام claude mcp list. احذف باستخدام claude mcp remove.

حالات الاستخدام

استخدامات عملية: Codebase to Course

توليد دورة تأهيل ذاتي التعلم لموظف جديد

👤 مديرو الهندسة / قادة التقنية ⏱ ~45 min beginner

متى تستخدمه: الجمعة بعد قبول العرض: تريد أداة تأهيل حقيقية بدلاً من 'اقرأ الكود'.

المتطلبات الأساسية
  • المهارة مُثبَّتة — git clone https://github.com/zarazhangrui/codebase-to-course ~/.claude/skills/codebase-to-course
  • المستودع مُستنسَخ — git clone قياسي
الخطوات
  1. مسح المستودع
    codebase-to-course: scan ./our-app. Output the proposed course structure first — section list — before writing.✓ تم النسخ
    → TOC محدد: البنية والوحدات وتدفقات الطلبات
  2. توليد الدورة
    Looks good. Generate the full HTML to /onboarding/course.html. Target audience: new full-stack hire who knows React + Node but not our domain.✓ تم النسخ
    → ملف HTML مُولَّد؛ يفتح في المتصفح
  3. التحقق من الدقة
    Spot-check: does the 'auth flow' walkthrough match what's actually in src/auth/? Quote the real code.✓ تم النسخ
    → العرض يستشهد بمسارات ملفات حقيقية وكود حالي

النتيجة: أداة تأهيل حقيقية توفِّر للفريق أسبوعين من الشرح.

المزالق
  • الدورة طويلة جداً للقراءة فعلاً — حدِّد الأقسام القصوى؛ الجودة على الشمولية
  • مقتطفات الكود تصبح قديمة — أعِد التوليد بعد إعادة الهيكلة الكبرى؛ المهارة سريعة
اجمعها مع: filesystem · git-mcp-idosal

شرح ميزة معقدة لمدير منتج غير تقني

👤 قادة التقنية ⏱ ~20 min beginner

متى تستخدمه: مدير المنتج يسأل باستمرار 'لماذا يستغرق هذا 3 sprints' — تريد أداة ملموسة.

الخطوات
  1. تحديد النطاق على الميزة
    codebase-to-course: scope to src/payments/. Audience: PM with no engineering background. Lean on diagrams + analogies, light on code.✓ تم النسخ
    → الدورة عالية المستوى؛ كتل الكود في حدها الأدنى

النتيجة: مدير المنتج يمضي بنموذج ذهني.

المزالق
  • القياسات تُبسِّط إفراطاً — تحقق؛ المهارة تفضِّل الدقة إذا ضُغِط عليها

توليد صفحة 'كيف يعمل' لمشروعك مفتوح المصدر

👤 مشرفو المصادر المفتوحة ⏱ ~30 min intermediate

متى تستخدمه: README يحتوي الميزات لكن لا يوجد شرح معماري.

الخطوات
  1. التوليد كصفحة وثائق
    codebase-to-course: scan main branch. Output ARCHITECTURE.html for the docs site. Target: experienced devs evaluating the project.✓ تم النسخ
    → الناتج يُقرأ كدليل مساهم متأمِّل

النتيجة: تجربة مطور أفضل للمُقيِّمين والمساهمين.

المزالق
  • الدورة تبدو عامة (لا هوية للمشروع) — مرِّر اسم المشروع + تلميحات الأسلوب في prompt

التركيبات

اجمعها مع خوادم MCP أخرى لتحقيق نتائج x10

codebase-to-course-skill + filesystem

قراءة المستودع المحلي وكتابة الدورة

codebase-to-course: scan ./our-app, write /onboarding/course.html.✓ تم النسخ
codebase-to-course-skill + git-mcp-idosal

إنشاء دورة لمستودع خارجي دون استنساخ

Use GitMCP for owner/repo. Then codebase-to-course on top of that.✓ تم النسخ

الأدوات

ما يوفره هذا الـ MCP

الأداةالمدخلاتمتى تستدعيهاالتكلفة
scan_repo path دائماً أولاً 0
propose_toc scan_result, audience بعد المسح، قبل التوليد 0
generate_course scan_result, toc, target_html_path الخطوة النهائية 0
scope_to_subdir subdir_path monorepo كبير أو تركيز على ميزة 0

التكلفة والحدود

تكلفة التشغيل

حصة API
لا ينطبق
الرموز لكل استدعاء
كبير — المهارة تقرأ المستودع بالكامل (10k–50k token نمطياً)
التكلفة المالية
مجاني؛ tokens النموذج تُطبَّق
نصيحة
للـ monorepos، استخدم scope_to_subdir؛ لا تُنشئ دورة لكل شيء دفعة واحدة

الأمان

الصلاحيات والأسرار ونطاق الأثر

الحد الأدنى من الصلاحيات: filesystem-read filesystem-write
تخزين بيانات الاعتماد: لا شيء
نقل البيانات الخارجي: لا شيء — قراءة/كتابة محلية بحتة

استكشاف الأخطاء

الأخطاء الشائعة وحلولها

الدورة عامة جداً / لا تستشهد بكود حقيقي

اجعل prompt أكثر تحديداً؛ اطلب استشهادات file:line

المستودع كبير جداً؛ ينفد السياق

استخدم scope_to_subdir؛ أنشئ دورات لكل وحدة وارتبط بها

تنسيق HTML تالف

اطلب من المهارة التحقق من الناتج؛ أعِد التوليد إذا لزم

البدائل

Codebase to Course مقابل البدائل

البديلمتى تستخدمهاالمقايضة
Repomix + manual promptتريد تحكماً كاملاً في كيفية تغذية قاعدة الكود لـ Claudeإعداد أكبر؛ لا صيغة ناتج رأي
DocsGPT / Mintlifyتريد وثائق مستضافةمنتج مختلف كلياً؛ لا HTML ملف واحد
absolutely-skilled / autodocتريد وثائق API مُولَّدة تلقائياًمرجع API ≠ درس تعليمي

المزيد

الموارد

📖 اقرأ ملف README الرسمي على GitHub

🐙 تصفح القضايا المفتوحة

🔍 تصفح أكثر من 400 خادم MCP و Skills