Teknik Yazarlık

Bu sorular, yalnızca teknik yazarlık yapan katılımcılara gösterildi.

Anket katılımcılarının %12'si teknik yazarlık yaptığını belirtti ancak bu grubun yalnızca %9'u resmi iş rolü olarak teknik yazar unvanına sahip.

İş rolleri sorulduğunda katılımcılar birden çok seçenek belirleyebildi.

Ne tür dokümanlar yazıyorsunuz?

Geçen yıla kıyasla, müşteriye yönelik dokümanlar yazan geliştiricilerin sayısında yüzde 5 puan artış görüyoruz.

Doküman yazarken hangi araçları kullanıyorsunuz?

Gittikçe daha fazla sayıda kişi belge yazmak için geliştirici araçları kullandığından kod olarak dokümantasyon yaklaşımının popülerliği artıyor, net olarak 2021'den yüzde 6 puan daha fazla.

Teknik doküman yazmak için hangi işaretleme dilini kullanıyorsunuz?

Markdown hâlâ en popüler işaretleme dili ve teknik yazarlık yapanların %13'ü temel işlevselliğini zenginleştirmek için özel Markdown türlerini kullanıyor.

Farklı dokümanlar / kılavuzlar arasında içeriği yeniden kullanıyor musunuz?

Katılımcıların %80'inin içeriği yeniden kullanması gerekse de üçte birinden fazlası benzer içerikleri hâlâ manuel bir şekilde kopyalayıp yapıştırır.

%6

- doküman kontrollerini otomatikleştiren, doküman yazarlarının oranı. En popüler testler bozuk işaretleme, harici bağlantı ve kod örnekleri için kullanılıyor. İlginç bir şekilde, %10'u dil kontrollerini de otomatik hale getiriyor.

%58

- API'leri belgelemesi gereken ve API dokümantasyonunu otomatik olarak oluşturan geliştiricilerin oranı. %61'i çoğunlukla Swagger kullanmayı tercih ediyor.

%30

farklı konu, belge ve tekrar eden içerik türlerinin büyük bir kısmını otomatikleştiren şablonlar yapılandırarak rutin işleri otomatik hale getirin.

Ne tür şeyler için şablon yapılandırırsınız?

%47

- parametreleştirilmiş şablonlar kullananların oranı.

Dokümantasyon yazdığınız birincil dil nedir?

İngilizce, teknik dokümantasyon için açık ara en popüler birincil dildir. Çince çok daha düşük oranla ikinci sırada gelir.

%68

- teknik yazarlık için profesyonel bir araç kullanmayı düşünen teknik yazarların oranı.

Teknik yazarlık için profesyonel bir araç kullanmayı düşündünüz mü?

Teknik yazarlık yapan tüm katılımcıların %13'ü dokümanlarını zaten diğer dillere yerelleştiriyor ve %10'u yerelleştirmeyi planlıyor.

WritersideEAP

Doküman yazmak için profesyonel bir araç kullanmayı düşünen %68'lik kesim içinde misiniz?

Teknik doküman yazmaya yönelik yeni bir aracı denemek için Erken Erişim Programına katılın:

IntelliJ tabanlı IDE'lerle çalışır.
Markdown'ı, semantik işaretlemeyi ve ikisinin kombinasyonunu destekler.
Belge kalite otomasyonu için 100'ü aşkın yerleşik teste sahip.
Koşullar ve değişkenler içeren içeriği yeniden kullanmayı destekler.
Çeşitli içerik türleri ve karmaşık işaretleme ögeleri için yerleşik şablonlara sahip.

Erken Erişim Programımıza Katılın

Geri