[Gelistirici] Belge açılımı

Onur Küçük onur at pardus.org.tr
7 Şub 2010 Paz 17:40:20 EET


 Merhaba,

 Belge konusunda sıkıntı yaşadığımızı, çok eksiklerimiz olduğunu sıkça
konuşuyoruz. Ancak gerçekte ne durumda olduğumuzu, nasıl belgelere
ihtiyacımız olduğunu ve kimlerin belge yazdığının resmini çıkarmadan bu
iş çözülmeyecek.

 [1] adresine gerekli belgeleri listeleyebileceğimiz bir TODO listesi
koydum, bileşen yapısı belgesi için de kendi adımı yazdım. Siz de
yazılması gereken belgeleri bu adrese ekleyip, tercihen yanına da
adınızı yazıp ilgili belgeleri yazınız :)

 Konu olarak öncelikle geliştirici belgelerine ağırlık vermek, Pardus
işleyişi, Pardus teknolojileri gibi konuları net bir şekilde ortaya
koymamız gerekiyor. ReST dosyaları hazır olduktan sonra istediğimiz
yerlere aktarmamız da (WEB, Wiki vs.) kolay olacak.

 Belgelerin adı sanı ortaya çıktıkca gruplama ve düzgün bir dizin
yapısı oluşturmak niyetindeyim.

 Belge formatı için ReST (ReStructured Text) kullanacağız. LaTeX gibi
yetenekli, ancak çok daha rahat yazılan ve okunan bir teknoloji. HTML,
LaTeX, PDF vb. bir seri dönüştürücüsü var ve Python PEP vb. belgeleri
ReST ile yazılıyor. Kullanmak için docutils paketinden çıkan
araçları kullanabilirsiniz. Daha fazla bilgi için [2] ve [3] e
bakabilirsiniz.

 Belge dili olarak ben öncelikle İngilizce yazmayı, yazdığım belgeleri
de başkaları tarafından Türkçe'ye çevrilerek bu çalışma sırasında
kendilerini geliştirmelerine önayak olmayı düşünüyorum. Böylelikle
belgeler yazıldıkça da başta Türkçe olmak üzere diğer dillere
çevrilmesini de sağlayabileceğiz. 


[1] http://svn.pardus.org.tr/uludag/trunk/doc/TODO
[2] http://docutils.sourceforge.net/rst.html
[3] http://docutils.sourceforge.net/docs/user/rst/quickref.html

 
 hadin pamuk eller klavyeye,
-- 
 Onur Küçük                                      Knowledge speaks,
 <onur.--.-.pardus.org.tr>                       but wisdom listens




Gelistirici mesaj listesiyle ilgili daha fazla bilgi