docs-writer

Amaç

Koda uyan ve bir yazım profilini izleyen proje belgelerini yazar ve sürdürür.

Kaynak Skill amacı

Ne zaman kullanılır

Kullanıcıya görünen davranış değiştiğinde veya proje belgesi oluşturulacak, güncellenecek ya da denetlenecekse docs-writer kullanılır. Oluşturma kipi belirtilen okur ve amaç için belge yazar. Güncelleme kipi değişiklik aralığından eskiyen bütün belgelere gider; denetim kipi belge kümesini kontrol edip desteklenen sapmayı onarır. Kanıt betiği yazılmış komutları, yolları, bayrakları, yapılandırma anahtarlarını ve depo bağlantılarını gerçek projede doğrular. Yazım profili cümle ve paragraf uzunluğunu yönetir. İzlenemeyen iddia uydurulmaz, bilinmeyen diye işaretlenir.

Yazım aşaması, arayüzleri alıntılamadan önce gerçek kodu okuyarak başlar. Mevcut belgenin yapısını korur ve ilgisiz sayfaları yeniden biçimlendirmek yerine gerekli en küçük bölümü düzenler. Kanıt denetleyicisi depo içi bağlantıları izler; adı geçen komutları, bayrakları ve yapılandırma anahtarlarını doğrular. Yazar daha sonra betiğin ancak insan değerlendirmesine bırakabildiği okunabilirlik bulgularını inceler. Son rapor her düzenlenen belgeyi ve kalan uyarıyı belirtir.

Kaynak Skill amacı

Nasıl çalışır

Becerinin adımları, kaynak sırasıyla

Kaynak Skill akışı

Okuru ve kipi belirle Oluşturma, güncelleme veya denetimi seç; belgenin okurunu ve amacını adlandır. Güncellemede kullanıcıya görünen bir değişiklik yoksa docs: not_applicable bildir ve dur.
Kaynak Skill akışı
Etkilenen belgeleri bul Değişen adları, bayrakları, anahtarları ve yolları belgelerde ara.
Kaynak Skill akışı
Açık metin yaz Yazım profiline uyarak en küçük bölümü düzenle ve eylemi öne koy.
Kaynak Skill akışı
Başvuruları kanıtla Değişen her belgede proje kökünden kanıt denetleyicisini çalıştır; yalnızca alıntılanan her iddia projede varsa sıfır ile çıkar. Dayanaksız başvuruları düzelt.
Kaynak Skill akışı
Okunabilirliği değerlendir Betiğin tek başına kararlaştıramadığı yazım profili bulgularını review et.
Kaynak Skill akışı
Belge işini bildir Değişen belgeleri, kanıt sonuçlarını ve kalan yazım uyarılarını listele.
Kaynak Skill akışı

Temel kurallar

Oluşturulan veya değiştirilen her belgede kanıt denetleyicisini çalıştır.
Kaynak Temel kurallar
Komut, bayrak, yol veya anahtar yazmadan önce proje kodunu oku.
Kaynak Temel kurallar
Deponun seçilmiş yazım profiline uy.
Kaynak Temel kurallar
İzlenemeyen olguyu uydurmak yerine bilinmeyen diye işaretle.
Kaynak Temel kurallar
Belgenin yapısını koru ve gereken en küçük bölümü değiştir.
Kaynak Temel kurallar

Çıktı ve gate

Çıktı

Yazım kipini, değişen belgeleri, kanıt kararını ve kalan uyarıları bildir.
Kaynak Çıktı tanımı

gate

Beceri tanımı bir gate kuralı belirtmiyor.

Kaynak Skill tanımı

Kaynak