Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Trenton
- Teknik yazar:
- dave
- Projenin adı:
- Temel Modüller için Dokümanlar
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projede, temel Triton modüllerine ilişkin belgeleri inceleyip güncellemeyi öneriyorum. Bunlar, kullanıcıların Triton sistemi kurarken en sık etkinleştirmesi gereken modüllerdir.
Triton'ın modül belgelerinde yapılan iyileştirmeler, kullanıcıların ihtiyaçlarına uygun modülleri bulmalarına ve daha sonra sistemlerini kurmalarına ve kullanmalarına yardımcı olacak. İyi bir modül dokümantasyonu, kullanıcıların tartışma forumunda yanıt beklemeye gerek kalmadan temel sorularından bazılarının yanıtlarını bulmasına olanak sağlar.
Temel modüller minimum olarak şunları içerir: account, account_invoice, account_invoice_stock, account_product, company, country, currency, Party, product, purchase, Sales ve stock modülleri.
Triton dokümanları için üç ana hedef kitle vardır: kullanıcılar, sistem yöneticileri ve geliştiriciler. Dokümanların bunların her birine hedeflenmesine yardımcı olmak için her modüle ait dokümanların, doc dizininde ayrı dosyalara bölünmesini öneririm. Bu e-postalar, içindekiler tablosu ve modülün açıklamasını içeren dosyaları, modülün ayarlanmasına ilişkin talimatları, modülün kullanımıyla ilgili bilgileri ve modülün tasarımı ve yapısıyla ilgili ayrıntıları içerebilir. Modülün işlevselliğine bağlı olarak bu dosyalardan bazıları gerekli olmayabilir ve gerektiğinde fazladan dosyalar oluşturulabilir. Modül iyileştirmeleri, parti modülü için daha önce teklif ettiklerimle aynı olacaktır: https://codereview.tryton.org/297241003/#ps327231002
Dokümanlar şu anda Sphinx tarafından reStructuredText dosyaları kullanılarak oluşturulduğu için dokümanları bu şekilde yapılandırmak işe yarayacaktır. Dokümanlarda yaptığım değişikliklerde, bunlar da incelenebilmesi için Triton kod inceleme sitesine yüklenecektir. Gerekli güncellemeleri yapabileceğim. Herkes bu durumdan memnun kaldığında, belki de Triton'a eklenmek üzere onaylanabilirler.