Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Tryton
- Teknik yazar:
- dave
- Proje adı:
- Temel Modüller İçin Dokümanlar
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projede, temel Tryton modüllerinin belgelerini inceleyip güncellemeyi öneriyorum. Bunlar, kullanıcıların Tryton sistemi kurarken en sık etkinleştirmesi gereken modüllerdir.
Tryton'un modül dokümanlarında yapılan iyileştirmeler, kullanıcıların ihtiyaçlarına uygun modülleri bulmalarına, ardından sistemlerini kurup kullanmalarına yardımcı olacak. İyi bir modül dokümanı, kullanıcıların tartışma forumunda yanıt beklemek zorunda kalmadan bazı temel sorularına yanıt bulmalarına olanak tanır.
Temel modüller en azından şu modülleri içerir: account, account_invoice, account_invoice_stock, account_product, company, country, currency, party, product, purchase, sale ve stock.
Tryton dokümanları üç ana kitleye yöneliktir: kullanıcılar, sistem yöneticileri ve geliştiriciler. Dokümanları bu modüllerin her birine göre hedeflemek için her modülün dokümanının doc dizininde ayrı dosyalara bölünmesini öneririm. İçerik tablosu ve modülün açıklamasını, modülü ayarlama talimatlarını, modülün nasıl kullanılacağıyla ilgili bilgileri ve modülün tasarımı ve yapısıyla ilgili ayrıntıları içeren dosyalar bu kapsamda yer alabilir. Modülün işlevine bağlı olarak bu dosyaların bazıları gerekmeyebilir ve gerektiğinde ek dosyalar oluşturulabilir. Modül iyileştirmeleri, parti modülü için daha önce önerdiğimler gibi olacaktır: https://codereview.tryton.org/297241003/#ps327231002
Dokümanlar şu anda reStructuredText dosyaları kullanılarak Sphinx tarafından oluşturulduğundan, dokümanları bu şekilde yapılandırmak iyi bir fikir olacaktır. Dokümanda yaptığım değişiklikler, incelenebilmeleri için Tryton kod inceleme sitesine yüklenir ve gerektiğinde güncelleyebilirim. Herkes bu değişikliklerden memnun kaldığında, Tryton'a dahil edilmeleri onaylanabilir.