Artık çoğu kişi araçlarımızı bir ajanla kuruyor
Birkaç geliştirici ürünü yapıyoruz — bir olay-defteri veritabanı, S3-uyumlu bir nesne deposu ve başkaları. Son birkaç ayda bir değişim fark ettik: deneyenlerin çoğu tarayıcıda başlamıyor. Bir kod ajanına "bunu projeme ekle" diyorlar ve kurulumu ile bağlantıları ajan yapıyor.
Biz de ajanların dökümanımız üzerinde nasıl çalıştığını izlemeye başladık.
Bir ajanın tahmin edişini izlemek
Çoğu zaman iyi gidiyordu. Ama arada bir ajan, var olmayan bir yapılandırma parametresi uyduruyor, yanlış bir porta uzanıyor ya da neredeyse doğru bir endpoint çağırıyordu. Model aptal olduğundan değil — dökümanımız bir insanı ikna edip kuruma almak için yazılmıştı ve ajan, üç paragraf arayla dağılmış düzyazıdan gerçekleri yeniden kuruyordu. Bir ajanın çıkarım yapmak zorunda kaldığı her gerçek, sizin belirtmeyi başaramadığınız bir gerçektir.
Farklı bir okuyucu için ikinci bir doküman
Bu yüzden her sürümde ikinci bir dosya yayınlamaya başladık: documentation.ai.md. İnsan dökümanının daha kısa bir çevirisi değil — farklı bir okuyucu için, farklı bir doküman; daha katı bir kesinlik ölçütüyle.
İngilizce, yoğun ve kendi kendine yeten: yalnızca o dosyayı okumuş bir ajan ürünü kurabilir, yapılandırabilir ve çağırabilir. Sabit bölümler, sırayla:
- Tek satırlık kimlik
- Kurulum / çalıştırma — tam komutlar, tam imaj adları ve portlar
- Yapılandırma — her env değişkeni / anahtar, varsayılanıyla
- API hızlı başlangıç — sözde-kod değil, gerçek bir istek/yanıt
- Yönetim yüzeyi — ilk kimlik bilgisinin nasıl alındığı, sık işlemler
- Entegrasyonu etkileyen mimari gerçekler
- Bağlantılar
Pazarlama dili yok. Durum hakkında mutlak dürüstlük — bir şey erken ya da denetlenmemişse dosya bunu söyler; çünkü doküman abarttığı için bir ajanın kullanıcıya kararsız bir özelliği önermesi gerçek bir başarısızlıktır.
"Neden sadece llms.txt değil?"
Haklı bir soru, çok da alıyoruz. llms.txt'yi değiştirmeye çalışmıyoruz. O, içeriğinizin harika bir site düzeyi indeksi. documentation.ai.md ise per-ürün, per-sürüm bir operasyon dökümanı — ruhen llms-full.txt'ye daha yakın: indeks değil, eksiksiz. Temiz biçimde birbirini tamamlarlar.
Bunu bir standart yaptık
Ürünlerimizin hepsinde yeterince işe yarayınca, herkesin benimseyebilmesi için açık bir standart (CC BY 4.0) olarak yazdık:
Geliştirici araçları yapıyorsanız, kullanıcılarınızın ajanları zaten dökümanınızı okuyor. Bu sadece onların gerçekten ihtiyaç duyduğu sürümü yazmak.