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:
- SymPy
- Teknik yazar:
- lglattly
- Proje adı:
- Dokuman dizeleri arasında tutarlılık
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projede SymPy'nin doküman dizelerinde daha fazla tutarlılık sağlamayı hedefliyorum.
Danışmanlarımla birlikte çalışarak önce kod tabanında bir doküman dizesi için istenen biçimlendirmeyi belirlerim. Daha sonra, kod tabanındaki tüm doküman dizeleri için izlenecek bir belge biçimlendirme kılavuzu oluşturuyorum. Projedeki çalışmalarım, bir yandan dil kullanımı ya da terimler gibi başka tutarsızlıkları toplayıp giderirken mevcut doküman dizelerini güncellemek için yeni kılavuzu uygulamayı da kapsıyor. Mentorlarım ve ben, bu ek tutarsızlıkların nasıl ele alınacağıyla ilgili editoryal kararları birlikte veriyorduk. Bu şekilde oluşan biçimsel tercihler de rehbere ekleniyor.
Projenin nihai hedefi, SymPy'nin doküman dizelerinin şimdi ve gelecekte tutarlılığını korumaya yardımcı olmak için hem geliştiriciler hem de katkıda bulunanlar tarafından kullanılabilecek bir doküman biçimlendirme ve stil kılavuzu oluşturmaktır.