Dokümantasyon siteleri için llms.txt
Yayınlandı:
Dokümantasyon siteleri, llms.txt için ideal kullanım örneğidir: insanlar yapay zeka araçlarına sürekli olarak "sizin ürününüzde X'i nasıl yaparım" diye sorar ve özenle hazırlanmış bir dosya, bu modelleri doğrudan doğru sayfalara yönlendirir.
Dokümantasyon neden en çok fayda sağlar
Dokümantasyonunuz zaten cevapların kendisidir. llms.txt, bir modele bu cevapların temiz bir dizinini — başlangıç, kılavuzlar, API referansı — vermenizi sağlar; modelin gezinme menülerini, arama arayüzlerini ve pazarlama sayfalarını taramasına izin vermek yerine.
Yapınızdan oluşturun
Çoğu dokümantasyon sitesinde zaten bir sitemap.xml bulunur. Bu URL'leri düz bir şekilde dökmek yerine birkaç mantıklı bölüme ayırın:
# Acme Docs > Documentation for the Acme API: setup, guides, and the full endpoint reference. ## Getting started - [Quickstart](https://acme.com/docs/quickstart): First request in 5 minutes - [Authentication](https://acme.com/docs/auth): API keys and scopes ## Reference - [Endpoints](https://acme.com/docs/api): Every endpoint and parameter ## Optional - [Changelog](https://acme.com/docs/changelog): Release history
Markdown sürümlerine bağlantı verin
Birçok dokümantasyon çerçevesi (Docusaurus, MkDocs, Mintlify, GitBook ve diğerleri) her sayfanın bir Markdown veya düz metin sürümünü sunabilir. Bunlara bağlantı verin — page.md — böylece modeller, gezinme menüleri ve kenar çubukları olan işlenmiş HTML yerine temiz içeriği ayrıştırır.
Tam bağlam için llms-full.txt ekleyin
Daha büyük dokümantasyon setleri için, tüm metnin satır içine alındığı tamamlayıcı bir llms-full.txt yayınlayın; böylece bir aracı her şeyi tek bir getirmeyle alabilir. llms.txt'i özlü dizin olarak tutun.
Önce düzenleyin, sonra doğrulayın
Dosyayı ister elle yazın ister bir eklentiden oluşturun, çıktıyı gözden geçirin — otomatik oluşturucular genellikle çok fazla içerik ekleme eğilimindedir. Kalıplar için llms.txt örnekleri'ne bakın, ardından yapıyı ve her bağlantının çözümlendiğini doğrulamak için doğrulayın.