Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Trenton
- Teknik yazar:
- dave
- Proje adı:
- Temel Modüllerle İlgili Belgeler
- 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 çok etkinleştirmesi gereken modüllerdir.
Triton'ın modül belgelerinde yapılan iyileştirmeler, kullanıcıların ihtiyaçlarına uygun modülleri bulmasına ve ardından sistemlerini kurup kullanmalarına yardımcı olacak. İyi modül dokümantasyonu, kullanıcıların tartışma forumunda yanıt beklemeye gerek kalmadan bazı temel sorularına cevap bulmalarını 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 bir modülün dokümanlarının doc dizini içinde ayrı dosyalara bölünmesini öneririm. Bunlar, içindekiler tablosu ve modülün açıklamasını içeren dosyaları, modülü ayarlamaya yönelik talimatları, 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çerebilir. Modülün işlevlerine bağlı olarak, bu dosyaların bir kısmı gerekli olmayabilir ve gerektiğinde fazladan dosyalar oluşturulabilir. Modül iyileştirmeleri, parti modülü için daha önce teklif ettiklerimle uyumlu olacak: https://codereview.tryton.org/297241003/#ps327231002
Dokümanlar şu anda reYapılandırılmış Metin dosyaları kullanılarak Sphinx tarafından oluşturulduğu için dokümanları bu şekilde yapılandırmak işe yarayacaktır. Dokümanlarda değişiklik yaptığımda bu dokümanlar, Experimentton kod inceleme sitesine yüklenecektir. Böylece, bu belgeler incelenebilir ve gerekirse güncellenebilir. Herkes kendilerinden memnun olduğunda, umarız ki DoubleClick'e katılmak için onay alabilirler.