Teknik bir yazarla çalışma

Mevcut aşama:
Dokümanlar Sezonu 2021, 15 Mart 2021'de sona erdi. Zaman çizelgesini inceleyin.

Dokümanlar Sezonu için mentorluk yaptığınız teknik bir yazarla nasıl çalışacakları konusunda açık kaynak kuruluşlara yönelik bazı yönergeleri aşağıda bulabilirsiniz:

  • Teknik yazarı, açık kaynak dünyasıyla ve topluluğunuzla tanıştırın.
  • Teknik yazarın projenize katkıda bulunurken kullanılacak araç ve süreçleri kullanmasına yardımcı olun.
  • Teknik yazarın ürünle ilgili tam bir kavramsal bilgi edinebilmesi için ürününüzü ayrıntılı olarak açıklayın. Bu sayede teknik yazar, proje için yazarken kendine daha fazla güvenebilir ve daha otoriter olabilir.
  • Kitlenizin ihtiyaçlarını, yani ürününüzü kullanan geliştiricilerin ve/veya ürünü kullanan diğer grupların ihtiyaçlarını açıklayın.
  • Gerekli belgeleri tasarlamasına yardımcı olmak için teknik yazarla önemli kullanım alanları üzerine çalışma yapın.
  • Teknik yazarın dokümanları yazmadan önce kodu anlaması gerekiyorsa kodu gözden geçirin.
  • Teknik yazarı, konunun uzmanı olan kişilerle iletişime geçmek. Yani, ürününüzün belgelerinde değineceğiniz yönlerinden sorumlu olan geliştiriciler veya projeye katkıda bulunan diğer kişilerdir.
  • Teknik yazarın ihtiyaç duyduğu zamanı ve kaynakları, konunun uzmanlarından ve diğer topluluk üyelerinden almasını sağlayın.
  • Alakalı olduğu durumlarda dokümanlara anlamlı kod örnekleri eklemek için teknik yazarla birlikte çalışın.

Göz önünde bulundurulması gereken noktalar

Season of Docs'taki açık kaynak mentorlar, teknik yazarlar olmayabilir. Mentorların belgeleme becerisine sahip olması gerekmez. Teknik yazarlar bu becerileri projeye ve mentorluk ilişkisine taşır.

Bunun yerine mentorlar açık kaynak toplulukları, ürünler ve açık kaynak projenin kullandığı süreçler ve araçlar hakkındaki bilgilerini getirirler.

Mentorluk ilişkisinin önemli bir sonucu, teknik yazarın bu yılki Dokümanlar Sezonu’nda ödül veren ve başarılı bir deneyime sahip olması gerekir. Mutlu bir deneyim, teknik yazarların bu yılın Dokümanlar Sezonu kapanışından sonra açık kaynak projesine katkıda bulunmaya devam etme ve diğer teknik yazarların açık kaynakta çalışmaya hevesli hale gelme şansını artırır.