تنسيق llms.txt، ومرجع المواصفات
المرجع الكامل لتنسيق ملف llms.txt: العناصر المطلوبة والاختيارية، وقواعد Markdown، وصياغة الروابط، ونسخة llms-full.txt، وقائمة فحص للتحقق من ملفك.
آخر تحديث:
نظرة عامة على التنسيق
llms.txt هو مورد نصي عادي يستخدم Markdown وفق CommonMark. وقد يوجد في جذر المصدر أو في مسار
أكثر تحديداً مثل https://example.com/docs/llms.txt. يصف الملف الأكثر تحديداً ذلك
النطاق.
يمكن للمساعدات البرمجية المتوافقة ومسارات RAG ووكلاء البحث استخدام الملف كخريطة منتقاة. ولا يثبت
النشر وحده الاكتشاف أو الاستخدام، لذلك صرّح به باستخدام rel="describedby"
عند الحاجة، وقِس العملاء الذين تدعمهم فعلياً.
العناصر المطلوبة
يحدد مقترح أغسطس 2026 عنصراً إلزامياً واحداً:
- عنوان H1, يجب أن يكون السطر الأول H1 (
# Name) الذي يتضمن اسم المشروع أو الموقع.
ملخص الاقتباس، والمقدمة التفسيرية، وقوائم الملفات بعناوين H2، وملاحظات الروابط كلها عناصر اختيارية.
# Your Project Name
> One sentence describing what your project does and who it's for.
## Documentation
- [Getting Started](https://example.com/docs/start): Install and first steps.
- [API Reference](https://example.com/api): Full endpoint catalog.
## Optional
- [Changelog](https://example.com/changelog): Release history.
الأقسام الاختيارية
الأقسام عناوين H2 (##) تتبعها قوائم غير مرتبة من روابط Markdown. ومن أسماء الأقسام
الشائعة:
- التوثيق, التوثيق الأساسي والأدلة والمراجع.
- المنتج، وصفحات التسويق والأسعار والحالة.
- أمثلة، وعينات الرمز والدروس والعروض التجريبية.
- اختياري، وسجل التغييرات، والمدونة، وGitHub، ذات أولوية أقل للذكاء الاصطناعي.
- API، قسم مرجع API مخصص.
- حزم SDK, ومكتبات العملاء الخاصة بكل لغة.
اختياري يبقى وسمًا تحريرياً واضحاً للموارد الثانوية، لكن الإصدار V2 لا يمنحه دلالات معالجة خاصة.
# Acme SaaS
> Acme SaaS helps teams automate their billing workflows with a no-code dashboard
> and a REST API supporting 40+ payment providers.
## Product
- [Overview](https://acme.com/product): Core capabilities and use cases.
- [Pricing](https://acme.com/pricing): Plans, limits, and enterprise options.
- [Status](https://status.acme.com/): Uptime and incident history.
## Documentation
- [Quickstart](https://acme.com/docs/quickstart): Set up in under 5 minutes.
- [API Reference](https://acme.com/docs/api): REST endpoints, auth, rate limits.
- [SDKs](https://acme.com/docs/sdks): Node, Python, Ruby, Go clients.
- [Webhooks](https://acme.com/docs/webhooks): Event payloads and retry policy.
## Examples
- [Node.js integration](https://acme.com/examples/node): End-to-end payment flow.
- [Python integration](https://acme.com/examples/python): Subscription management.
## Optional
- [Changelog](https://acme.com/changelog): Version history.
- [Blog](https://acme.com/blog): Product updates and tutorials.
- [GitHub](https://github.com/acme/acme-oss): Open-source components.
صيغة الروابط
يتبع كل رابط صيغة Markdown - [Title](URL): short description.
- استخدم عناوين URL مطلقة بما في ذلك المخطط (
https://). - الوصف بعد النقطتين نص عادي؛ أبقه دون نحو 120 حرفاً واجعله مفيداً للذكاء الاصطناعي لا محشواً بالكلمات المفتاحية.
- رابط واحد لكل عنصر قائمة، ولا تضع قوائم داخل قوائم.
- فضّل عناوين URL الأساسية (مع شرطة مائلة في النهاية إذا كان هذا عرفك).
نسخة llms-full.txt
تستخدم المنظومة الأوسع ملفاً مصاحباً اختيارياً في /llms-full.txt. بينما llms.txt هو فهرس للروابط، llms-full.txt يحتوي على النص الكامل من تلك الصفحات المرتبطة مدمجة معاً ومنسّقة
بصيغة Markdown.
قد يجلب أداة تدعم الاتفاقية صراحةً llms-full.txt للسياق الموحد. والمقابل هو زيادة الحجم
والتقادم والتعرض الأمني.
اقرأ المخصّص دليل llms-full.txt لاستراتيجيات التوليد.
قائمة فحص
- الملف مقدّم في الجذر أو المسار المحصور المقصود
- نوع وسائط نص عادي أو Markdown بترميز UTF-8
- يبدأ بعنوان H1 واحد بالضبط
- لا يحتوي الاقتباس والمقدمة الاختياريان على عناوين
- تُحل أهداف الروابط بصورة صحيحة في سياق نشرها
- ملاحظات الروابط الاختيارية موجزة وواقعية
- حجم الملف مبرَّر بالمهام والعملاء الذين جرى اختبارهم
- لا وسوم HTML، ولا قوائم متداخلة
- جرى التحقق باستخدام مدقّق llms.txt
الأخطاء الشائعة
- عناوين URL نسبية,
- [Docs](/docs)لن تُحل بصورة صحيحة عندما يجلب زاحف ذكاء اصطناعي الملف. استخدم دائماً عناوين URL مطلقة. - اقتباس مفقود, فهذا ليس خطأ توافق مع V2. أضف ملخصاً فقط عندما يساعد ملخص واقعي قصير العميل المقصود.
- نوع Content-Type خاطئ, مع تقديمه باستخدام
text/htmlأو إن غاب نوع المحتوى، فقد ترفض بعض المحللات الملف. - أوصاف محشوة بالكلمات المفتاحية، وتقرأ نماذج الذكاء الاصطناعي هذه حرفياً. ويؤدي حشو الكلمات المفتاحية إلى تدهور إشارة الجودة.
- سرد كل صفحة, انتقِ أهم 10 إلى 30 رابطاً. استخدم
sitemap.xmlلاكتشاف عناوين URL الشامل. وملف مصاحبllms-full.txtقد تجمع المحتوى لسير عمل إدخال متوافق صراحة، لكنها لا تستبدل خريطة الموقع.
أدلة ذات صلة
- كيفية إنشاء llms.txt, خطوة بخطوة لأي حزمة تقنية.
- دليل llms-full.txt, ملف مصاحب للمحتوى الكامل.
- المدقّق، وافحص ملفك من حيث توافق المواصفة.
- المولّد، أنشئ ملفاً من نموذج.
- أفضل الممارسات، وما ينبغي تضمينه وما ينبغي تخطيه.
- أي زواحف الذكاء الاصطناعي تقرأ llms.txt، وحالة الاعتماد.