Bir sayfa yıllarca eski olup yine de doğru olabilir
Belgeleme sessizce bayatlar ve tarihe göre denetlenir. Bu, değişmesi gerekmeyen sayfaları işaretler ve geçen salı yanlış olan sayfayı kaçırır.
Yaş zayıf bir vekildir. İki yıl önce yazılmış kavramsal bir sayfa tamamen doğru olabilir. Geçen ay düzenlenmiş bir hızlı başlangıç, altındaki bir varsayılan değiştiği için yanlış olabilir.
Yanlışlık iki şey arasındaki ilişkidir: kodun şimdi yaptığı ve sayfanın yaptığını söylediği. Kontrol etmek ikisini okumak demektir. Okuma dardır: parametre adları, varsayılanlar, dönüş şekilleri ve gereken sıra.
Çelişki alıntılanmış halde işaretlemek bunu kullanılabilir kılar. Belki bayat sayfaların bir listesi yok sayılır. Bu satır X diyor ve kod artık Y yapıyor diyen bir liste düzeltilir.
ActionFlow tuvalde nasıl çalışır
Akışa iki girdi girer. Bir GitHub node son kontrolden beri birleşen değişiklikleri verir. Bir Notion veya HTTP Request node yayımlanmış belgeleme sayfalarını verir.
Bir Filter node değişiklikleri kamuya açık bir yüzeye dokunanlara indirger (imzalar, varsayılanlar, yapılandırma, kamuya açık türler). Çünkü iç bir yeniden düzenleme bir sayfayı yanlış kılamaz.
Bir Loop node kalan değişiklikleri dolaşır. Her biri için bir Generate Object node değişen davranışı anlatan belgeleme pasajlarını alıntılanmış döndürür.
İkinci bir Generate Object geçişi her pasajı değişikliğe göre yargılar ve üç durumdan birini döndürür: alıntıyla çelişen, eksik veya etkilenmemiş.
Üç durumlu yanıt çıktıyı kısa tutan şeydir. Çoğu pasaj etkilenmemiş döner ve kimseye ulaşmaz.
Bir Filter node çelişen ve eksik bulguları tutar. Bir Sort node çelişkileri öne koyar. Çünkü okuyucuları etkin yanıltanlar onlardır.
Bir GitHub node etkilenen her sayfa için alıntı ve değişikliği taşıyan bir kayıt açar. Bir Slack node sayıyı belgeleme kanalına yazar.
Akış hiçbir sayfayı düzenlemez. Düzeltmeyi, çelişki önünde, bir kişi yapar.
Bu ActionFlow'un kullandığı node'lar
- GitHub (Integration): son kontrolden beri birleşen değişiklikler.
- Notion (Integration) ile HTTP Request (Util): yayımlandığı haliyle belgeleme sayfaları.
- Filter (Data): kamuya açık bir yüzeye dokunan değişikliklere indirger.
- Loop (Control): her şey üzerinden bir geçiş değil, değişiklik başına bir geçiş.
- Generate Object (AI Core): değişen davranışı anlatan pasajlar, alıntılanmış.
- Generate Object (AI Core): pasaj başına çelişen, eksik veya etkilenmemiş.
- Sort (Data): önce çelişkiler.
- GitHub (Integration): etkilenen her sayfa için alıntı ve değişiklik taşıyan bir kayıt.
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.