Dökümantasyon Hazırlama

Hazırlamış olduğumuz herhangi bir tema veya web uygulaması için, kullanıcıların uygulamayı daha kolay kullanması veya kurması için bazı zamanlar dökümantasyon hazırlamak durumunda kalırız. Örneğin ücretsiz olarak dağıttınız bir wordpress teması var ise, bu tema için dökümantasyon hazırlamanız kullanıcılar açısından büyük bir kolaylık sağlayacaktır. Themeforest gibi platformlarda satışa sunulan temaların hemen hemen hepsinde dökümantasyon bulunmaktadır. Fakat bu içeriği oturup yazmak elbette sıkıcı bir iştir. Bu problemi ortadan kaldıracak bir çok basit uygulama bulunuyor. Bu uygulamaları kullanarak hızlı bir şekilde ürünümüze uygun bir dökümantasyon şablonu oluşturup, yine hızlı bir biçimde içeriğini oluşturabiliyoruz. Bu yazıda bu aşamadaki Markdown uygulamasından  bahsedeceğim.

Markdown John Gruber tarafından oluşturulmuş,  çok kolay bir şekilde temel HTML öğeleri oluşturarak  düz bir metin biçimlendirme yönetimidir. Markdown ile çok hızlı bir şekilde tema dökümantasyonları oluşturabilir veya başka işleriniz için kullanabilirisiniz.

 

MarkdownPad (Windows)

Mou (OS X)

MarkdownNote (OS X & iOS)

Tema Dökümantasyonu Yaratmak

Markdown için hazırlanmış olan sözdizimini incelemenizi öneriyorum. Böylelikle ihtiyacınız olan kalıpları öğrenebilirsiniz.  Şimdi sırasıyla temamız için, uygun bir dökümantasyonun nasıl yazılacağını uygulamalı olarak göreceksiniz.

Belge İçerisinde Neler Olabilir ?

Bir web uygulamasın detaylarını içeren bir belge hazırlamak biraz sıkıcı gelebilir. Bir dokümantasyon dosyasının amacı, diğer kullanıcılar ve alıcılar için bir rehber olmasıdır. Çoğu zaman belge içerisinde, kurulum, özelleştirme ve ürünü satın alan veya kullananların, ürün hakkında bilmesi gerektiği bazı ipuçları ve ufak eğitimler bulunur. Bunun yanında lazım olacak ek dosyalarda bu belgeye eklenebilir.

  • – Bilgilendirme
    • Üretici
    • Üretilme Tarihi
    • Version
    • Üretici İletişim Adresi
  • –Dosya Yapısı
    • HTML
    • CSS
    • Javascript
  • –Özel Stiller
  • –Tweaking Dosyaları
    • Tweaking CSS
    • Tweaking Javascript
  • –Browser Uyumluluğu
  • –Değişiklikler

Bu tarz şablonları, themeforest üzerinden ürün satın alanlar sanırım aşinadır. Bu belgede önemli olan kullanıcılara neyin nerede olduğunu ve nasıl olduğunu kısa bir şekilde özet geçmektir. Örneğin;  image slider geçiş efekt hızı değişikliğinin hangi js dosyası üzerinden ve hangi satırdan yapıldığını göstermelidir.

Bir Cevap Yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir