Görev dokümantasyonu
Her görevin teknik bir dokümantasyonu vardır: kişilerin yazdığı bir teknik açıklama ve geliştirici notları, ve Botream'in görevin kendisinden oluşturduğu bir teknik özet. Dokümantasyonu dokümantasyon penceresinde okur, sonraki geliştirici veya görevi inceleyen bir yönetici için PDF rapor olarak indirirsiniz.
Özet, pencereyi her açtığınızda veya PDF'i her indirdiğinizde görevin o anki hâlinden yeniden oluşturulur; böylece doküman görevin gerisinde kalmaz. Oluşturulan hiçbir şey saklanmaz.
Dokümantasyonu açma
- Düzenleyicide: Documentation düğmesi (History ve Compare yanındaki sayfa simgesi).
- Tasks sayfasında: görevin ⋯ menüsü → Documentation; raporu hemen almak için Download PDF.
Pencere görev adını, klasörünü ve sürümünü, özetin ne zaman oluşturulduğunu gösterir; örneğin 4. sürümden 12 Eki 2026 10:30 tarihinde oluşturuldu.
| Oluşturulduğu yer | Ne zaman |
|---|---|
| Published version | Zamanlamaların ve çalıştırmaların kullandığı sürüm. Public listesinde ve düzenleyicinin genel görünümünde varsayılandır. |
| My local copy | Çektiğiniz veya klonladığınız kopya; kaydettiğiniz ama yayınlamadığınız değişikliklerle birlikte. Yerel çalışma alanınızda varsayılandır. Düzenleyicideki kaydedilmemiş değişiklikler dahil değildir: önce kaydedin. |
Yayınlanmış bir görevin yerel kopyası sizde varsa pencerenin üstünden ikisi arasında geçiş yapın.
Yazılı bölümler
Teknik açıklama görevin ne işe yaradığını, neye ihtiyaç duyduğunu, ne yaptığını ve ne ürettiğini anlatır. Geliştirici notları sonraki geliştiricinin bilmesi gerekenleri tutar: hassas ekranlar, test verileri, bilinen sorunlar, yapılacaklar.
- Written documentation kartında Edit'e tıklayın.
- Markdown ile yazın; her alanın yanındaki önizleme sonucu gösterir.
- Save'e tıklayın.
Kullanabileceğiniz Markdown:
| Yazın | Sonuç |
|---|---|
# Başlık, ## Başlık |
Başlıklar |
- madde veya 1. madde (iç içe için iki boşluk girinti) |
Listeler |
**kalın**, *italik* |
kalın, italik |
`kod` ve ``` arasındaki satırlar |
Kod |
> metin |
Alıntı |
Kaydetmek için Edit tasks yetkisi gerekir (görevi açabilen herkes dokümantasyonu okuyabilir ve PDF'i indirebilir). Çekme (pull) gerekmez: yazılı bölümler bir sürüme değil göreve aittir. Botream bunları kimin, ne zaman kaydettiğini ve o anki görev sürümünü hatırlar ve kaydı denetim günlüğüne işler (TASK_DOCUMENTATION_UPDATE).
Not: Yazılı bölümler kaydedildikten sonra görev yeniden yayınlandığında pencere Bu açıklama yazıldıktan sonra görev değişti (sürüm 3 → 5) uyarısını gösterir. Metni göreve göre kontrol edip yeniden kaydedin; oluşturulan özet her zaman günceldir.
Yapay zekâ ile iyileştirme
Improve with AI yazılı bölümleri düzenli ve iyi yapılandırılmış bir dokümana dönüştürür. Botream oluşturulan özeti ve düzenleyicilerdeki metinleri (kaydedilmiş olsun olmasın) Administration → Settings → AI altında kurulan yapay zekâ modeline gönderir ve şunları alır:
- Amaç, Girdiler, İşlem adımları (sade bir dille), Çıktılar, Hata yönetimi ve Bağımlılıklar başlıklarıyla bir teknik açıklama;
- her bilgiyi, uyarıyı ve yapılacak işi koruyan, düzenlenmiş geliştirici notları.
Sonuç mevcut metnin yanında gösterilir. Dili seçin (English veya Türkçe; varsayılan uygulamanın dilidir), başka bir sürüm isterseniz Try again'e tıklayın. Apply to the editors sonucu kaydetmeden düzenleyicilere koyar; istediğinizi değiştirip Save'e tıklayın.
Parolalar, anahtarlar ve bağlantı dizeleri asla gönderilmez: özet kasaların, kimlik bilgilerinin ve bağlantıların adlarını içerir, gizli bilgilerini içermez. Yapay zekâ modeli yoksa düğme devre dışıdır ve kimin kuracağını söyler.
Oluşturulan özet
| Bölüm | Gösterdiği |
|---|---|
| Overview | Görevin açıklaması, üst düzey adımları (step açıklamaları) ve başındaki yorumlar |
| Inputs and outputs | Tür, varsayılan değer ve zorunluluk bilgisiyle input ve output tanımları |
| Variables | Görevin tanımladığı her değişken, türü ve nereden geldiği |
| Process flow | Komutlar girintili bir taslak olarak: adımlar, if/elseif/else, switch/case, döngüler, retry, try/catch/finally, onerror; her biri tek satırlık bir özetle; devre dışı komutların üstü çizilidir |
| Dependencies | Uygulamalar ve pencereler (pencere değişkenleri, window --action:open/attach, run, SAP bağlantıları), web adresleri (browser, restapi), dosyalar ve klasörler, veritabanları (bağlantı adı, sağlayıcı, sunucu ve veritabanı; bağlantı dizesi asla), e-posta hesapları (sunucu, kasa ve kimlik bilgisi adları), kasalar ve kimlik bilgileri (yalnızca adlar), çağrılan görevler (runtask, stoptask…), kuyruklar, insan görevleri ve yapay zekâ kullanımı |
| Schedules and triggers | Görevi neyin başlattığı, etkin olup olmadığı, sonraki çalışma ve nerede çalıştığı |
| Error handling | onerror, try/catch blokları, retry blokları, --onerror:continue içeren komutlar, --retry ve throw |
| Version history | Yayınlanan her sürüm; yazanı, tarihi ve notuyla |
| Statistics | Komut, blok ve devre dışı komut sayısı, en derin iç içe geçme, kategoriye göre komutlar ve son 100 çalışmanın başarı oranı |
Gizli görünen değerler (password veya token gibi adlandırılmış bir değişkene set, --password, bağlantı dizeleri, istek başlıkları) *** olarak gösterilir.
PDF rapor
Download PDF raporu sunucuda aynı verilerden oluşturur: görev adı, klasör, sürüm ve tarihle bir kapak, içindekiler, yazılı bölümler, ardından tablolar ve akış taslağıyla oluşturulan bölümler. Kapaktan sonraki her sayfada sayfa numarası ve Botream · görev · sürüm N · oluşturulma tarihi alt bilgisi bulunur.
Uygulamanın dili için düğmeye tıklayın veya English ya da Türkçe seçmek için menüsünü açın. Bölüm başlıkları seçilen dili izler; komutlar, parametreler ve adlar olduğu gibi kalır. Yazı tipi gömülüdür; Türkçe harfler her yerde doğru basılır.
API: GET /api/tasks/{id}/documentation.pdf?lang=en|tr&source=published|local.