Technical Writer ajanı
Technical Writer ajanı bir değişikliğin kullanıcıya yönelik dokümantasyonunu yazar veya günceller. Feature SDLC'yi kapatır; taslağı oturumun özeti de olur.
Technical Writer ajanı, değişikliği kullanacak kişiler için yazar. Yeni kullanıcı dokümantasyonunun taslağını hazırlar veya mevcut olanı günceller; böylece bir özellik bir açıklamayla birlikte yayına çıkar.
Nerede çalışır
| İş akışı | Adım |
|---|---|
| Feature SDLC | User docs |
Feature SDLC'nin sekizinci ve son adımıdır. Özelliği uygulayan adımları izler; bu yüzden kod yazıldıktan ve projenin testleri çalıştıktan sonra çalışır. O ana kadar oturumda Product Analyst'ten gelen gereksinimler, Architect'ten gelen bir teknik tasarım, yazıldığı hâliyle backend ve frontend değişikliği, uçtan uca senaryolar ve bir güvenlik incelemesi bulunur. Yazar, gerçekte geliştirileni belgeler.
En son çalıştığı için çıktısı, testler çalıştıktan sonra yazılmış olarak oturum sayfasında oturumun özeti de olur.
Girdiler
- Oturumun görevi.
- Projenin reposundaki, göreve uygunluklarına göre seçilmiş dosyaların salt okunur bir anlık görüntüsü.
- Önceki yedi adımın tamamı, sığmaları için kısaltılmış hâlde.
- Yazıldığı hâliyle değişiklik (uzunsa sığacak şekilde kısaltılmış ve kesildiği yer işaretlenmiş bir diff) ve kaydedilen test sonucu.
Çıktılar
Metin hâlinde bir dokümantasyon taslağı: yeni sayfalar veya bölümler, mevcut olanlardaki değişiklikler ve her birinin nereye ait olduğu. Onu geliştiren mühendisler için değil, ürünün kullanıcıları için yazılır.
Bu adım çalıştığında kod zaten yazılmıştır; bu yüzden taslak aynı oturumda dosyalara dönüştürülmez. Diff, ancak kod geçişi onu yazdıysa dokümantasyon içerir; örneğin görev bir kılavuz istediği için. Taslağı repoya almak için, onu dosya olarak isteyen bir takip oturumu gönderin.
Örnek çalıştırma
Gösterim amaçlı bir örnektir, kaydedilmiş bir oturum değildir. Filtre ön ayarları için Technical Writer, mevcut filtreleme kılavuzuna bir "Kaydedilmiş görünümler" bölümü ekler. Mevcut filtrelerin nasıl kaydedileceğini, kaydedilmiş bir görünümün nasıl uygulanacağını ve nasıl silineceğini; kaydedilmiş görünümlerin kişisel olduğunu ve 20 sınırı bulunduğunu açıklar. Değişiklik günlüğü taslağına bir satır ekler ve düğme göründüğünde kılavuzdaki eski bir ekran görüntüsünün güncelliğini yitireceğini not eder.
Sınırlar
- Ekran görüntüsü alamaz veya özelliğin nasıl göründüğünü kontrol edemez.
- Değişikliği kendisine gösterilen diff'ten belgeler ve uzun bir diff sığacak şekilde kısaltılır. Taslağı diff'in tamamıyla karşılaştırın.
- Taslağı değişikliğe yazılmaz. Dokümantasyon pull request'e ancak kod geçişi onu yazdıysa veya bir takip oturumu aracılığıyla girer.
- Konsol kataloğundaki ayrı Docs Writer ajanı bugün hiçbir yerleşik iş akışında kullanılmaz.
Sık sorulan sorular
Hazırladığı dokümantasyon pull request'te yer alır mı?
Bu adımdan gelmez. Kod yazıldıktan sonra çalışır; bu yüzden taslağı oturum sayfasında metin olarak kalır. Diff'te dokümantasyon ancak kod geçişi onu yazdıysa bulunur; örneğin görev bir kılavuz istediği için. Taslağı dosya olarak eklemek için bir takip oturumu gönderin.
Dokümantasyon stilimize uyabilir mi?
Reponuzdaki mevcut dosyaları okur; bu yüzden onlara uyma eğilimindedir. Daha katı kurallar için, Technical Writer adında bir özel ajanla talimatlarını geçersiz kılın.