Her şeyi yeniden yazmak, belgelemenin sesini kaybetme yoludur
Eskimiş belgeleme büyük ölçekte düzeltilince sayfalar genellikle sıfırdan yeniden yazılır. O tam yeniden yazım sayfayı tutmaya değer kılan kısımları kaybeder: birinin öğleden sonrayı harcayıp doğru ettiği örnek, bir destek isteğinden sonra eklenen uyarı veya bir müşterinin size geri alıntıladığı ifade.
İşleyen düzeltmeler dardır: bir parametre adı, bir varsayılan değer ve artık farklı sırada olan bir adım. Sayfanın gerisi özgün yazarın yazdığı gibi kalır.
O küçük düzeltmeyi bulmak için hem kodu hem sayfayı okur, sonra yanlış olan somut cümleyi yakalarsınız. Bu iş, sayfayı yeniden üretmekten zordur. Bu ayrıntı düzeyinde agent düzenlemeler önerir ve onları bir bakımcının bir dakikada inceleyebileceği bir fark olarak gösterir. Hiçbir şey yayımlanmaz. Kararı sayfanın sahibi verir.
Agent Studio'da bu agent nasıl kurulur
Prompt skills belgeleme sahipliğini, stil kılavuzunuzu ve bilerek yalınlaştırılmış işaretlediğiniz sayfaları tutar. Bunlar doğruluk için asla düzeltilmemelidir.
Sistem prompt'u her düzenlemenin olabildiğince küçük olmasını ve hem özgün cümleyi hem onu çürüten kodu alıntılamasını ister.
Yeniden yapılandırmayı, ton değişikliklerini ve düzeltme dışındaki her düzenlemeyi yasaklar. Agent'ın aklına gelen iyileştirmeler farka değil bir nota gider.
Çelişki verilen koddan türetilemiyorsa agent bölümü olduğu gibi bırakır. Tahminden düzenlemez.
GitHub node değişen kodu ve belgeleme kaynağını verir. Agent Chat node ikisini okur. Soru somut değişikliktir.
Önerilen düzenlemeler GitHub node üzerinden pull request olarak gönderilir, sayfa başına bir pull request, açıklamada çelişkiyle birlikte.
Birleştirme olmaz. Bir Human in the Loop node her pull request'i sayfanın sahibine gönderir. Yalınlaştırılmış işaretli sayfalar kuyruğa hiç girmez.
Bu agent nelerden oluşur
- Prompt skills: sahiplik, stil kılavuzu ve bilerek yalın bırakılmış sayfalar.
- System prompt: en küçük düzenlemeler; hem cümle hem çelişen kod alıntılanır.
- System prompt: yeniden yapılandırma yok, ton değişikliği yok. İyileştirmeler bir nota gider.
- System prompt: çelişki kurulamıyorsa düzenleme yok.
- GitHub (Integration): değişen kod ve belgeleme kaynağı birlikte.
- Agent Chat (Util): ikisini okur; soru somut değişikliktir.
- ActionFlow yeterli olduğunda: Bir değişikliğin çeliştiği bölümleri işaretlemek yetiyorsa, iş akışını kurun. Birçok ekip yalnızca işareti ister.
Sık sorulan sorular
Bülten
Ürün güncellemelerini alın
Yeni node'lar, agent'lar ve ürün notları. Yalnızca açmaya değer bir şey varken e-posta göndeririz.