MUHYAL'ın Teknik Makale Yazım Yönergeleri

Selam sevgili okur! MUHYAL, sunucu yönetimi ve yazılım mühendisliği ile ilgili teknik makaleler koleksiyonunu oluşturmaya devam etmekten heyecan duymaktayız. MUHYAL makalelerinin tutarlı, kaliteli ve bir stile sahip olmasını sağlamak için aşağıdaki yönergeleri geliştirdik.

Makale yapısı;

  1. Başlık
  2. Kısa özet
  3. Ön koşullar
  4. Adımlar
  5. Makaleyi sonuçlandırma
  6. Kaynaklar (Opsiyonel)

Başlık

Tipik bir başlık şu biçimi izler:
<İşletim Sistemi> <Yazılım> <Kılavuz türü>

Örneğin;
Ubuntu üzerinde LAMP nasıl kurulur?

Giriş

Her makalenin ilk bölümü, genellikle bir ila üç paragraf uzunluğundaki Giriş bölümüdür. Girişin amacı okuyucuyu motive etmek, beklentileri belirlemek ve okuyucunun makalede ne yapacağını özetlemektir.

Makaleniz şu sorulara yanıt veriyor mu?
Öğretici ne hakkında? Hangi yazılım söz konusudur ve bileşenleri nelerdir (kısaca)? Okuyucu neden bu konuyu öğrenmeli? Bu özel yazılımı bu yapılandırma ile kullanmanın faydaları nelerdir? Okuyucu bu öğreticide ne yapacak ya da oluşturacak? Bunlar, okuyucuların ihtiyaç duyduğu motivasyonu sağladığından ve konu hakkında onları heyecanlandırdığından, lütfen açıklayıcı olun, vakit ayırın. Okuyucu makale bittikten sonra ne başardı? Ne gibi yeni becerilere sahip oldular? Daha önce yapamadıkları neyi yapabiliyorlar?

Ön şartlar

Amaç, okuyucunun mevcut makaleyi okumadan önce ne yapması gerektiğini tam olarak belirtmektir.

Örneğin;

  1. Yazılım kurulumu ve yapılandırması…
  2. Gerekli DNS ayarları veya SSL sertifikaları gibi…

Sonuç

Makalenizdeki işlemleri uygulayarak okuyucunun neler başardığını özetlemelidir. “Nasıl yapılacağını öğrendik…” gibi ifadeler kullanmak yerine “yapılandırdığınız” veya “oluşturduğunuz” gibi ifadeleri kullanın.

Görseller ve açıklayıcı materyaller

Görseller önemli bir noktayı, adımı hızlı bir şekilde gösterebilir veya bir adımda ek açıklama sağlayabilir. Arayüzlerin ekran görselleri, etkileşimli diyalog ve sunucu kurulum şemaları için görselleri kullanın. Kodların, yapılandırma dosyalarının, çıktıların veya makaleden kopyalanıp yapıştırılabilecek herhangi bir şeyin görsellerini kullanmayın.