Yazılım Geliştiricileri, Neden Henüz Teknik Yazmaya Başlamadınız?

Bir blog yalnızca sizin için değil, teknoloji alanındaki diğer yazılım geliştiriciler için de pek çok nedenden dolayı yararlı bir parçadır.

Teknik yazı, bir yazılım geliştiricisinin teknik bilgilerini/deneyimlerini yazılım mühendisliğindeki diğer yazılım geliştiricilerle paylaşmasına yardımcı olur.

Teknik yazı, karmaşık bilgilerin belirli bir görevi yerine getirmek veya belirli bir hedefe ulaşmak için ihtiyaç duyan kişilere iletilmesini içeren bir yazma disiplinidir. Bu nedenle teknik yazı genellikle “ karmaşık olanı basitleştirmek ” olarak tanımlanır.

Ayrıca yazdığınız konuya ilişkin anlayışınızı artırır ve teknik uzmanlığınızı açıkça gösterir.

Teknik yazarlıkla ilgili en benzersiz şey, yalnızca gelecekte mükemmel fırsatlar yaratabilmeniz değil (teknoloji alanında uzaktan bir iş, serbest yazarlık sözleşmesi veya büyük bir teknoloji şirketinin web sitesinde misafir gönderme fırsatı vb.) Sonunda bir yazılım geliştiricisi olarak kariyerinizde size yardımcı olacak çevrimiçi bir varlık.

Bazen belirli bir konu hakkında bilgi ararken geri dönüp blog yazılarımı okurum.

Yazılım mühendisliği kariyerinizde ilginç bir şey yaptıysanız ancak bunu kendinize saklıyorsanız, büyük bir fırsat yaratıcısını kaçırıyorsunuz demektir.

Yazmaya başlayın; bu fikirlerinizi internette tanıtmanın etkili bir yoludur.

“Bulmayı dilediğin blogu şu durumlarda yaz: https://t.co/PcXR0fL9QF

- Ankur💻🎧💪 (@TheAnkurTyagi) 3 Ekim 2023

Ayrıca Başkalarının öğrenmesine yardımcı olmayı seviyorsanız, açık kaynaklı projelerin bir parçası olmaktan ve başkalarına nasıl katılabileceklerini göstermekten hoşlanıyorsanız veya karmaşık fikirleri yazınız aracılığıyla anlaşılması kolay yollarla açıklamaktan tatmin oluyorsanız, o zaman teknik yazı sizin için mükemmel bir seçimdir. Sen.

Bu makalede, geliştirici becerilerimizi geliştirmek için programlama ve yazmanın nasıl birleşebileceğini açıklamayı amaçlıyorum. Evet, yazıyorum! Gerçekten hepimizin belli düzeyde yazma yeteneğine sahip olduğunu düşünüyorum. Daha yetkin bir geliştirici ve iletişimci olmanıza yardımcı olacak yazma ipuçları, tavsiyeler ve örnekler sunmak için buradayım.

Teknik Yazı Nedir?

Teknik yazı, kullanıcıların, geliştirici arkadaşlarının veya yöneticilerin teknik bir ürünü veya teknik beceriyi veya fikri anlamalarına yardımcı olmak için açık ve ayrıntılı talimatlar vermekle ilgilidir.

Teknik yazar, bu eğitimleri ve teknik belgeleri oluşturan kişidir.

Teknik yazı şöyle olabilir:

• Kullanıcı kılavuzları veya iki teknik SaaS arasındaki entegrasyon nasıl yapılır?
• Çevrimiçi destek makaleleri
• Genellikle araştırma veya deneyler yapıldıktan sonra belirli bir konu hakkında bilgi sunan Teknik Raporlar . Bilim ve mühendislik alanlarında yaygındırlar.
• Teknik Teklifler : Bu belgeler bir planın, fikrin veya projenin açık ve ikna edici bir şekilde ana hatlarını çizer. Onay, finansman veya işbirliği istemek için kullanılırlar.
• Programcılar için dahili meta materyaller ve geliştiriciler için API belgeleri .

Temelde, teknik bir yazar, teknik ayrıntıları, okuyucunun bu bilgiyi belirli bir amaç için etkili bir şekilde uygulamasını sağlayacak şekilde aktarır.

Teknik yazmaya başlıyorsanız ve yazılım geliştirme/programlama veya teknolojide öğrendikleriniz hakkında yazmaya çalışıyorsanız ancak henüz ilk blogunuzu yazmadıysanız, en büyük değeri blogun ilk iki bölümünde bulacaksınız. Teknik yazar veya blog yazarı olarak nasıl başlayacağınızı ve blogunuzu nasıl ölçeklendireceğinizi anlattığım bu blog yazısı.

Blogun geri kalanını, bir yazılım geliştirici yazarı olarak başarılı olmak, iş yerinde başarılı olmak ve kariyerinizi ilerletmek için ihtiyaç duyacağınız bilgi boşluklarını doldurma konusunda faydalı bulacaksınız.

“Eğer bir hayaliniz varsa, bir ömür boyu çalışarak, plan yaparak ve ona hazırlanarak geçirebilirsiniz. Yapmanız gereken şey başlamaktır."

—Drew Houston

Yazmak Her Yerde mi?

İnsanların kodlamayı öğrenmek için kullandıkları en iyi iki çevrimiçi kaynak, teknik belgeler ve Yığın Taşması'dır; bloglar ise ilk üçü tamamlar.

İnsanların kendi kendilerine teknoloji hakkında bilgi sahibi olmalarını sağlamanın üçlüsü, net belgeler, çözümler sunan canlı bir topluluk ve sık sık gönderileri içerir.

Geliştiriciler, nasıl yapılır videoları, yazılı eğitimler, kitaplar ve forumlar dahil olmak üzere çok çeşitli ek kaynaklara değer verir; öğrenme tarzlarına en uygun kaynakları ve formatları bir araya getirirler.

Fikirlerinizi ekip içinde ve çevrimiçi olarak açıkça ifade edebilmek, birçok geliştiricinin bunu zorlayıcı bulduğu için değerli bir beceridir. Her gün kod yazmayı gerektirmeyen ne kadar yazı yazdığınızı bir düşünün. Bu beceri bir süper güçtür.

Slack sohbetleri, e-postalar, dahili geliştirici belgeleri, RCA taslakları, benioku, kod yorumları, Git taahhüt mesajları, çekme istekleri, kod inceleme yorumları, yıllık performans geri bildirimleri, toplantı notları ve daha fazlası gibi çeşitli yazma biçimleriyle meşgul olursunuz.

Yazma konusunda uzmanlaşmak yazılım geliştiriciler için çok önemlidir. Yetersiz yazma becerileri belirli bir noktadan sonra kariyer ilerlemelerini engelleyebilir. Pek çok mühendis kariyerlerinin ilerleyen dönemlerinde "sosyal becerilerin kod kadar önemli olduğunu" fark eder.

Gençler: Her gün 30 dakika yazmaya başlarsanız ve her ay çevrimiçi olarak 2-3 blog yayınlarsanız, yazılım mühendisliği kariyeriniz önemli ölçüde gelişecek ve gelecekte teknoloji alanında daha iyi fırsatlar elde edeceksiniz, ancak çok az geliştirici bunu gerçekten yapabiliyor. uzun vadeli. https://t.co/damIJ5gXys

- Ankur💻🎧💪 (@TheAnkurTyagi) 4 Ekim 2023

Yazmak Geliştiriciler İçin Neden Önemlidir?

JavaScript, TypeScript, PHP, Go, Java — piyasada pek çok farklı programlama dili var ve hatta bunların çoğunda akıcı olabilirsiniz.

Teknoloji kariyerimizde daha yüksek kalitede kod üretmeye çalışırken, günlük dilde etkili bir şekilde yazma ve iletişim kurma yeteneği, yazılım mühendisliği alanında hafife alınabilecek çok önemli bir beceri haline geliyor.

Yazılım mühendisliği sadece koddan ibaret değildir. Bu insanlar + kodla ilgili.

Yazılım Mühendisi Olarak Nasıl Daha İyi Bir Yazar Olabilirim?

Mühendislerin kod hakkındaki düşüncelerini nasıl dile getirdikleri, kodun kendisi kadar kritik olabilir. Bu konudaki duruşunuz ne olursa olsun, sözlerimizin kodun etkinliğini artırma ya da engelleme gücüne sahip olduğunu oybirliğiyle kabul edebiliriz.

Yazmak, şansınızın yüzey alanını artırmanıza yardımcı olabilir.

L = D*T, burada L şanstır, D yapıyor ve T anlatıyor.

– Jason C. Roberts

Teknik Yazının 6 Önemli Faydası

Kavramları daha derin bir düzeyde anlamanıza yardımcı olur.

• Açıkladığınız kavramları araştırmanız gerekir, bu da sizi farklı fikirlere, uygulamalara ve kazanımlara maruz bırakır.

• Başkalarına açıkladığınızda kavramlar beyninizde daha iyi yerleşir.

• Bilgileri başkaları için yapılandırıp sunarak, çoğu zaman bilginizdeki boşlukları ortaya çıkarırsınız. Sonuç olarak, geliştirici kariyerinizde daha hızlı ilerlemenize de yardımcı olur.

• Teknik yazarlar hayat boyu öğrenenlerdir çünkü araştırdığınız ve yazdığınız her yeni teknik blogla o konuda uzman olacaksınız.

• Yazmak aynı zamanda kullanıcı empatisinin daha derin anlaşılmasını da teşvik eder. Yalnızca kendi bakış açınıza güvenmek yerine, okuyucuların veya ürün kullanıcılarının bakış açılarına ve duygularına daha fazla odaklanmanızı sağlar.

  
  

• İşte bazı ek avantajlar:

Ayrıca teknik yazar olarak çeşitli organizasyonlara katkıda bulunarak gelir elde edebilirsiniz. Bu Harika Şirketler-Kim-Ödeyen-Teknik-Yazarlara göz atın.

Üniversitede Bir Hostelde Başkalarına Özel Ders Vererek Okudum

Bir şeyi açıklamak, hatta öyleymiş gibi yapmak sizi bilginizi tutarlı bir şekilde düzenlemeye zorlar, bilginizdeki boşlukları ortaya çıkarır ve bildiğiniz kısımları pekiştirir.

Öğrenmenin en iyi yolu öğretmektir ve yazmak her geliştirici için büyük bir değerdir.

İnsanlar ve işletmeler sadece dikkat etmek yerine buna karşılık verirler. Teknik bir blog yazısı yazdığınızda anında geri bildirim alırsınız. Teknik yazılarınız aynı zamanda haberin yayılmasına da yardımcı olur ve daha ilgi çekici fırsatların kapılarını açar.

Eğer hoşunuza giderse teknik yazarlık alanında kazançlı bir kariyer de var ve bugünlerde blogumda yazdığım hemen hemen her şey, daha iyi anlamaya çalıştığım kavramlar. Yazılı olarak açıklayamıyorsam, konuyu tam olarak kavrayamıyorum demektir.

Teknik Yazı Örnekleri Nelerdir?

Teknik bir yazar olarak göreviniz, karmaşık teknik bilgilerin erişilebilir ve kullanıcı dostu bir dile çevrilmesini içerir. Teknik yazı, adım adım öğreticiler ve kapsamlı kılavuzlar oluşturmak da dahil olmak üzere çeşitli biçimleri kapsar.

Temel amaç, ister dahili ekip üyeleri ister son kullanıcılar arasında bir ürün veya hizmetin teknik yönlerinin anlaşılmasını kolaylaştırmaktır.

Bunu akılda tutarak, aşağıdaki teknik yazı örnekleri size net bir anlayış sağlamalıdır.

1. SuperTokens İncelemesi – Auth0, Firebase Auth ve AWS Cognito'ya Açık Kaynak Alternatifi.

Bu, süper belirteç incelemesinin çok basit bir örneğidir ve "süper belirteçlerin" neden iyi bir kullanıcı kimlik doğrulaması olduğunu gösterir.

2. Next.js E-ticaret Mağazası Oluşturmak İçin Medusa Nasıl Kullanılır

Bu, bir uygulama geliştirmenin yanı sıra nasıl bir eğitim oluşturabileceğinize dair çok iyi bir örnektir. Bu blogda Shopify'a açık kaynak alternatifi olan Medusa ile adım adım e-ticaret mağazası kurma kılavuzunu paylaştım.

3. Yüksek Lisans'lar MindsDB ve OpenAI ile Nasıl Dağıtılır?

Bu kılavuzda LLM'leri MindDB ve OpenAI ile nasıl dağıtabileceğinizi paylaştım

4. Veritabanınızı Supabase'den HarperDB'ye Nasıl Taşıyabilirsiniz?

Veritabanınızı Supabase'den HarperDB'ye nasıl geçirebileceğinize dair eksiksiz bir eğitim

5- Ürün Dokümantasyonu

Ürün belgeleri, diğer geliştirici araçlarının etkili bir şekilde kullanılmasına ve bu araçlarla entegre edilmesine ilişkin talimatlar içerir.

Ürün belgeleri yazmak, iyi teknik yazma becerileri ve organizasyon bilgisi gerektirir. Bunlar, araştırma, görselleştirme ve çok çeşitli hedef kitlelerle bağlantı kurma becerisinde yüksek düzeyde beceri gerektiren teknik yazının kapsamına giren örneklerden sadece birkaçıdır.

İpucu- “Kendinize şu soruyu sorun: 'Başlık okuyucunun ilgisini çekiyor mu?' Eğer öyleyse, muhtemelen giriş kısmına girecekler ve ardından 'Bu parçanın tamamına zaman ayırmaya değer mi?' diye karar verecekler. Teknik yazılarda sık sık gözlemlediğim yaygın bir hata, tanıtımın fazla olması veya tam tersine çok az olmasıdır.

Hassas bir şekilde hazırlanmış bir paragraf, teknik bir blog yazısı için etkili bir zemin hazırlayabilir.

Teknik Yazar Olarak Nasıl Başlarım?

Şu ana kadar "Teknik Yazarlık veya Blog Yazma" ile ilgili aldığım en yaygın soru nasıl başlayacağımla ilgili.

Hayatta bir şeyi yapmanın ve olmak istediğin şeye ulaşmanın önündeki en büyük engel, başlamak gibi görünüyor.

En kötü düşman “kendinden şüphe duymaktır”. pic.twitter.com/fw1691QRSY

- Ankur💻🎧💪 (@TheAnkurTyagi) 10 Ağustos 2023

Yeni bir egzersiz rejimine başlamak, bir maraton için antrenman yapmak, bir iş kurmak, bir kitap yazmak ya da daha spesifik olarak bu durumda yazmak olsun, en zor kısım her zaman başlamaktır.

Ne yapmanız gerektiğini tartışarak sayısız saatler harcamak kolay ve caziptir.

"Okumak", "okumak" ve "çalışmak", "yazmaya" başlamaktan çok daha kolaydır.

Ancak işin sırrı, her seferinde yalnızca bir adım atmanız gerektiğidir.

Yazılım mühendisliği kariyerinizde en az bir bileşik varlık oluşturun

– Bir blog başlatın– Bir bülten başlatın– YT videoları kaydetmeye başlayın– Bir podcast başlatın– Ağ oluşturmaya başlayın

Oluşturun, Yayınlayın ve Tekrarlayın

İnternette geleceğin fırsatları sizi bekliyor

Cc @TheAnkurTyagi

- Kap.ts (@Kaperskyguru) 17 Şubat 2023

Ve etrafına bak; yazılım mühendisliğindeki çoğu geliştirici 7/24 kod yazmıyor; çoğumuz her gün başka şeyler yaparak bolca zaman harcıyoruz.

Bu şunları içerir:

• Bir şirket veya müşteriler içindeki ekip genelinde yeni bir işlevin tanıtılması.
• Ürününüzdeki yeni veya eski bir özelliği belgelemek.
• JIRA biletiyle ilgili güncelleme.
• Bu yeni özelliği desteklemek için birikmiş iş oluşturma.

Elbette banyo/öğle yemeği molaları ve Twitter'da gezinmek için de her zaman vakit vardır 😉

o yüzden fazla düşünmeyin, sadece başlayın

“Yazmak basketbol oynamayı öğrenmek gibidir.”

– David Perell

Başarılı bir yazar olmak ve fırsatları yakalamak için 3 beceriye sahip olmanız gerekir.

• Kodlama
• yazı
• İngilizce

Evet, yazmaya bile başlamadan önce, zamanları, yazılışları ve temel dil bilgisi de dahil olmak üzere İngilizceyi anlamalısınız.

Okuyucularınız dilbilgisi hataları ve kötü kelime seçimleriyle dolu bir makale okumak istemez.

Teknoloji endüstrisinde İngilizce, dünya çapındaki yazılım geliştiriciler, mühendisler ve diğer teknoloji profesyonelleri arasındaki iletişimin fiili dili haline geldi. Belgeleme, programlama dilleri ve geliştirme için kullanılan araçlar için kullanılan dildir.

Fikirleri Basit ve Açık Bir Şekilde İletmeyi Öğrenin

Teknik bir özelliğin nasıl uygulanacağını bilmek, mutlaka süreci başkalarına açıklayabileceğiniz anlamına gelmez.

İyi bir öğretmen olmak empati yapmayı ve bilgiyi hedef kitlenize uygun bir şekilde aktarma becerisini gerektirir.

Altı yaşındaki bir çocuğa açıklayamadığınız bir şeyi anlamıyorsunuz demektir.

Einstein, Albert

Olağanüstü bir yazar olmak için kusursuz bir strateji yoktur. O zaman bu konuyu neden tartıştığımı merak edebilirsiniz. Çünkü bunu en başından itibaren ele almak çok önemli.

“Bir strateji aramayın; Yazarken benzersiz sesinizi arayın ve tarzınızı oluşturun.

Bilmeniz gereken tek yazma tüyosu.

• Daha az teknoloji daha çoktur; zamanın %90'ında React ile çalışıyorum.

• İlk kez yazıyorsanız, anlamak için kendinize daha fazla zaman tanıyın.

• Kendinize kötü yazma izni verin.

• Hazırlanmayı bırakın ve harekete geçin.

  
  

Yapay Zeka Çağında Nasıl Öne Çıkan Yazar Olunur?

Bir sonraki blog yazınızı yazmadan önce, ChatGPT'den konu hakkında bir yazı yazmasını ve internette halihazırda mevcut olan genel şeylerin neler olduğunu göstermesini isteyin, böylece bunu söylemekten kaçınabilir ve hedef kitle için neyin önemli ve benzersiz olduğunu yazabilirsiniz.

- Ankur💻🎧💪 (@TheAnkurTyagi) 16 Şubat 2023

Hedef kitlenizi anlamak için yazmaya başlamadan önce bu soruları sorun.

• Okuyucularınız kimler?
• Google'da ne arıyorlar veya hangi sorunla karşılaşıyorlar?
• Şu anda hangi blogları okuyorlar?
• Nasıl okuyacaklar?

Blog Yazısı Fikirleri Nasıl Bulunur?

• Sizi Google'da saatlerce araştırmaktan ve kafanızı kaşımaktan kurtaracak makaleyi yazın.

• Yeni bir şey öğrendiğinizde, onu nasıl öğrendiğinizi ve ne öğrendiğinizi yazın.

• Alanınız, ilgi alanlarınız veya mesleğiniz hakkında bir hikaye yazın.

• En sevdiğiniz blog yazarının keyifli bulduğunuz bir blog gönderisini seçin ve aynı konuyu yeni bir bakış açısıyla keşfedin veya farklı bir konuyu benzer bir açıdan ele alın.

  
  

Bir şeyi Google'da arattığınızda bulmayı dilediğiniz blog yazısını yazın.

- Ankur💻🎧💪 (@TheAnkurTyagi) 20 Mart 2023

Not- Yazılım mühendisliği kariyerinizde ilginç bir şey yaptıysanız ancak bunu kendinize saklıyorsanız, büyük bir fırsat oluşturucuyu kaçırıyorsunuz demektir.

Fikirlerinizi etkili bir şekilde tanıtmak söz konusu olduğunda internette en iyi şekilde yazı yazarak gezinebilirsiniz.

Teknik yazılar ve eğitimler yazmak için güzel bir nokta var. Henüz bu şeyi öğrenmeye vakti olmayan profesyoneller için yazın ve bunu zaten bildikleri şeylerle ilişkilendirin. Örneğin jQuery bilen birine modern bir JS tekniğini anlatmak.

- Rachel Andrew (@rachelandrew) 20 Şubat 2019

Çözüm

Yazmak çoğu yetenekli geliştirici için kolay elde edilen bir meyvedir.

Bir blog yazısı okuyarak teknoloji konusunda çok şey öğrenebileceğinizi düşünüyorsanız; bu hafta bir tane yazmayı deneyin.

- Ankur💻🎧💪 (@TheAnkurTyagi) 2 Ekim 2023

Her geliştiricinin yazılım mühendisliğinde öğrendikleri hakkında bir blog yazısı yazmasının nedeni, yazmanın onlara, belki de bir şeyi sandıkları kadar iyi anlamadıklarını keşfetmelerini sağlamasıdır.

Herhangi bir şey hakkında öğretmek ve yazmak, onu öğrenmenin en iyi yoludur ve yeni bir yaşam tarzına başlamanız sizin için kolay bir meyvedir çünkü zaten ilk elden deneyiminiz vardır, bu yüzden tek yapmanız gereken ortaya çıkıp 12 blog yazısı yazmaktır. bu yıl sonuçları değerlendirin ve bir sonraki hamlenizi planlayın!

"Noktaları toplamak için okuyun, onları birleştirmek için yazın." - David Perell

Sonuç olarak, yazma becerilerinizi geliştirmek ve yazılarınıza biraz daha fazla çaba harcamak, bir geliştirici olarak yeteneklerinizi gerçekten geliştirebilir. Diğer görevlerin yanı sıra diğer geliştiricilerle işbirliği yapmak, çalışmanızı sürdürmek, gerektiğinde içeriğinizi oluşturmak ve hatta proje tekliflerinin taslağını hazırlamak için bu ipuçlarını yararlı bulabilirsiniz.

Teknik Yazı Kaynakları

• Teknik Yazım Önerileri (CSS Tricks'ten Chris tarafından yazılmış iyi yazılmış bir blog yazısı)
• Teknik Yazım Kaynakları ( Cynthia Peter'ın GitHub deposu)
• Google'ın Teknik Yazım Kılavuzu
• Teknik Yazım Temelleri
• Dokümanları Yaz