كيفية إنشاء ملف llms.txt
نُشر: · حُدِّث:
يستغرق إنشاء ملف llms.txt نحو عشر دقائق. يشرح هذا الدليل كل جزء منه بالترتيب، وينتهي بملف يمكنك نسخه وتكييفه حسب احتياجك.
1. ابدأ بعنوان H1
يجب أن يكون السطر الأول عنوان H1 واحدًا — وهو اسم مشروعك أو موقعك. وهو العنصر الوحيد المطلوب بصرامة في هذه الصيغة.
# Acme Docs
2. أضِف ملخّصًا على شكل اقتباس
أسفل العنوان مباشرةً، أضِف اقتباسًا من جملة أو جملتين. هذا هو السياق الذي يقرؤه النموذج اللغوي أولًا، لذا اجعله محدّدًا: ما هو الموقع ولِمَن هو موجَّه.
> Acme is a payments API. This file links to the docs an LLM needs to integrate and debug Acme.
3. (اختياري) أضِف بضعة أسطر نصّية
قبل أي عنوان قسم، يمكنك إضافة فقرات عادية تقدّم توجيهًا إضافيًا. لا تستخدم عناوين هنا — واجعلها مقتصرة على جملة أو جملتين.
4. اجمع روابطك ضمن أقسام H2
كل قسم هو عنوان H2 يتبعه قائمة بصيغة markdown. كل عنصر هو رابط مع وصف اختياري بعد نقطتين رأسيتين.
## Docs - [Quickstart](https://acme.com/docs/quickstart): Integrate in five minutes - [API reference](https://acme.com/docs/api): Every endpoint and parameter ## Examples - [Sample app](https://acme.com/examples/app): A working end-to-end example
استخدم عناوين URL مطلقة بصيغة https، واجعل الأوصاف مركّزة على ما يحتاجه المطوّر أو النموذج — وليس على نصوص تسويقية.
5. استخدم قسم "Optional" للعناصر المرغوبة دون أن تكون ضرورية
القسم المسمّى ## Optional هو العُرف المتّبع للمعلومات الثانوية — روابط يمكن للوكيل تجاوزها عند الحاجة إلى سياق أقصر. ضع هنا سجلات التغييرات ومقالات المدوّنة والمراجع الثانوية.
6. استضفه في الجذر — أو في المسار الذي يغطّيه
قدّم الملف على العنوان https://yourdomain.com/llms.txt مع Content-Type: text/plain. ويمكن أن يوجد أيضًا في مسار فرعي فيغطّي الصفحات الواقعة تحته: فملف /docs/llms.txt يصف كل ما في /docs/، والوكلاء يفضّلون الملف الأكثر تحديدًا من بين المنطبقة (انظر ما الذي تغيّر في المواصفة v2). كما تنشر المواقع الكبيرة غالبًا ملف llms-full.txt يحتوي المضمون الكامل موسّعًا.
7. اجعل صفحاتك تشير إليه
حتى لا يضطرّ الوكلاء إلى تخمين العنوان، أعلن عن الملف من صفحاتك بواسطة <link rel="describedby" href="/llms.txt"> — أو بترويسة الاستجابة Link: المكافئة، التي يكفي ضبطها مرة واحدة في إعدادات شبكة التوصيل.
8. تحقَّق من الصحة قبل النشر
الصق نطاقك في أداة التحقّق. فهي تفحص البنية، وتتأكّد من أن كل رابط يعمل فعلًا، وتعرض بالضبط ما يجب إصلاحه. اسعَ إلى تحقيق 100/100.