Teknik Yazarlık

Paylaş:

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?

86%

Şirket içi belgeler

61%

Kod dokümanları

57%

Müşteri dokümanları

1%

Diğer

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?

46%

Özelleştirilebilir bir metin düzenleyici 

32%

Confluence

28%

Bir Office uygulaması

24%

GitHub Pages

24%

Google dokümanlar

21%

Bir wiki platformu

2%

Profesyonel yardım belgesi yazma çözümü

15%

Diğer

2%

Hiçbiri

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?

77%

Markdown

18%

Emin değilim / WYSIWYG düzenleyici veya Office benzeri bir uygulama kullanıyorum

13%

Özel bir Markdown değişkeni

5%

AsciiDoc

5%

XML / DITA / DocBook vb.

4%

reStructuredText

4%

Diğer

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?

42%

Evet, yeniden kullanılabilecek içerikleri kod parçacıklarında saklayarak farklı belgelerden onlara referans veriyorum

37%

Hayır, araçlarım tek kaynak desteklemediği için benzer içerikleri kopyalayıp yapıştırıyorum

20%

Hayır, aynı içeriği yeniden kullanma ihtiyacım olmuyor

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?

74%

Farklı konu/doküman türleri

46%

Uyarı blokları gibi tekrarlayan içerikler

26%

Karmaşık Markup elementleri

%47

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

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

63%

İngilizce

22%

Çince

6%

Japonca

1%

Fransızca

1%

Korece

1%

Rusça

6%

Diğer

İ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ü?

68%

45%

Evet

32%

55%

Hayır

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.
Teknik Yazarlık:

2022

Zaman ayırdığınız için teşekkür ederiz!

Raporumuzu faydalı bulduğunuzu umuyoruz. Bu raporu arkadaşlarınızla ve meslektaşlarınızla paylaşın.

Herhangi bir soru ya da öneriniz varsa lütfen bizimle surveys@jetbrains.com adresinden iletişime geçin.