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:
- Mattermost
- Teknik yazar:
- @anindita_basu
- Proje adı:
- Ürün İçi Metni İnceleyip Geliştirme
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Slack kanalına katıldım ve Eric'e bazı sorular gönderdim. Yanıtına göre (teşekkür ederiz Eric),
Bu projeye şu şekilde yaklaşmanızı öneriyorum:
Dizeleri sınıflandırma
Öncelikle, hangi dizelerin (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) sistem konsolunda, hangilerinin kullanıcıya yönelik olduğunu belirlemeye başlayacağım. İlk olarak kullanıcılara yönelik dizeleri incelemeyi öneriyorum.
Dizeleriniz için bir stil kılavuzu oluşturun
Menü öğeleri, işlem düğmeleri, etiketler, başlıklar, araç ipuçları, hatalar, uyarılar, doğrulamalar, bildirimler ve onaylarda kullanılan dizelerde büyük harf kullanımı, uzunluk ve kelime kullanımı için stil tanımlamak istiyorum (https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG adresindeki örnek stil kılavuzu ekran görüntüsüne bakın). Ayrıca, dizelerde (özellikle de birleşik dizelerde) jetonların (yer tutucular) kullanımıyla ilgili bazı yönergeler oluşturmak isterim.
Bu kılavuzu A4 boyutunda bir sayfaya sığdırmayı, mümkünse daha kısa tutmayı amaçlıyorum. Amaç, bu dizeleri yazan geliştiriciler kılavuzu hızlı ve kolay bir şekilde bulmalıdır. Ayrıca, kullanıcı arayüzü metni takip edildiğinde tüm ekranlarda tutarlılık gösterecektir.
Bunu iki nedenden dolayı öneriyorum: (a) Metin içeriğinde dil bilgisi ve üslup açısından tutarlılık olması için (b) GSoD sona erdikten sonra bile kullanıcı arayüzü metni yazarken herkesin hızlıca başvurabileceği bir talimat seti olması için
Metni inceleyip hassaslaştırın
#2'de oluşturulan stil kılavuzuna göre, dizeleri düzenleyecek ve GitHub'da pull istekleri oluşturacağım.
=============
Süre
Henüz dizelerin kaçının kullanıcılara yönelik olduğunu bilmiyorum (bu projede incelemeye alınmasını önerdiğim şey budur). Stil kılavuzunun oluşturulmasının (taslak aşamasından onay aşamasına kadar) yaklaşık 3 hafta süreceğini tahmin ediyorum. Bu çalışma, dizeleri sistem dizesi veya kullanıcıya yönelik olarak sınıflandırmayla aynı anda yapılabilir. Projenin standart uzunlukta (3 ay) bir proje olduğu ve bu zaman çerçevesi içinde mümkün olduğunca çok sayıda dizeyle inceleme halledeceğim varsayımıyla başlamayı öneriyorum.
Tam zamanlı olarak çalıştığım için bu projede günün sadece bir kısmında çalışabiliyorum. Azaltılmış çalışma saatlerim nedeniyle daha uzun süreli bir projeye ihtiyacım olacağını düşünüyorsanız buna açığım.