الدليل

أمثلة على llms.txt

أسرع طريقة لكتابة ملف llms.txt جيّد هي البدء من ملف ناجح. إليك ثلاثة أنماط يمكنك تكييفها.

1. الملف البسيط

مثالي لمنتج صغير أو صفحة هبوط. عنوان، وملخّص، وقسم واحد من الروابط الأساسية.

# Acme

> Acme turns CSV files into charts. This file links to the docs an LLM needs to help users.

## Docs

- [Quickstart](https://acme.com/start): Upload a CSV and get a chart in 60 seconds
- [Pricing](https://acme.com/pricing): Plans and limits

2. الملف الغني بالتوثيق

لمواقع واجهات البرمجة/حِزم التطوير (API/SDK). جمّع الروابط حسب الغرض، واربط بنُسخ الصفحات بصيغة Markdown، واستخدم قسم Optional للمواد الثانوية.

# Acme API

> REST API for chart generation. Authentication, endpoints, and SDKs below.

## Getting started

- [Authentication](https://acme.com/docs/auth.md): API keys and scopes
- [Quickstart](https://acme.com/docs/quickstart.md): First request in 5 minutes

## Reference

- [Endpoints](https://acme.com/docs/api.md): Every endpoint and parameter
- [Errors](https://acme.com/docs/errors.md): Error codes and handling

## Optional

- [Changelog](https://acme.com/changelog.md): Release history

3. اقتران llms.txt + llms-full.txt

كثيرًا ما تنشر مجموعات التوثيق الكبيرة كليهما: llms.txt بوصفه الفهرس، وllms-full.txt مع المحتوى الكامل مُضمّنًا بحيث يستطيع الوكيل استيعاب كل شيء في جلب واحد.

انسخ البنية، لا المحتوى

أيًّا كان النمط الذي تختاره، اجعل الأوصاف محدّدة، واستخدم روابط HTTPS مطلقة، وتأكّد من أن كلًّا منها يعمل. ثم مرّره عبر أداة التحقق للتأكّد من أنه يحقّق درجة 100.

تابِع القراءة

تحقّق من ملف llms.txt الخاص بك →