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:
- Creative Commons
- Teknik yazar:
- JackieBinya
- Projenin adı:
- WordPress temel tema kullanım kılavuzu
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
GSOD-2020'in teknik yazar başvuru aşamasında, Creative Commons WordPress temel tema doküman projesinin mentoru olan Hugo Solar ile birkaç kez etkileşime geçtim.
Onunla ilk iletişimimde, WordPress temel tema kullanım kılavuzunu oluşturma hedeflerini anlama konusunda yardım istedim. Çok yardımcı oldu ve beni projeye hemen dahil etti. Bundan sonra, art arda gerçekleştirilen tüm etkileşimlerimiz CC WordPress Base tema dokümanlarının hedeflerini hassaslaştırmayla ilgiliydi.
Projenin şartlarını ve hedeflerini anladığımı düşündüğüm bir aşamaya geldiğimde CC WordPress Temel Teması Kullanım Kılavuzu için bir taslak teklif oluşturmaya başladım.
Teklif, stajyer başvuruları için Creative Commons'un resmi şablonu kullanılarak oluşturuldu. Bu dokümanda, proje özeti, önerilen proje yapısı ve yeni WordPress Temel Tema dokümanının düzeni hakkında bilginin yanı sıra belge oluşturma aşamasıyla ilgili zaman çizelgeleri ve teslimatlar hakkında bilgi verilmektedir.
Ardından Hugo Solar, taslak teklifimi inceledi ve iyileştirmeler yapmam için geri bildirimde bulundu. Bu süreç boyunca kendisi projeyle ilgili soruları yanıtlamaya her zaman hazırdı.
Verilen geri bildirimi uyguladım. D&I rozeti oluşturma dokümanlarıyla ilgili nihai önerimi aşağıdaki bağlantıda Google Dokümanı olarak bulabilirsiniz.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
Alternatif olarak, teklifimin kısa bir özetini aşağıda bulabilirsiniz:
Creative Commons - WordPress temel tema kullanım kılavuzu Jacqueline Binya tarafından hazırlanan bir teklif, 28 Haziran 2020
Proje Özeti Bu projenin nihai hedefi, Creative Commons WordPress Temel Teması için zengin, sezgisel, ilgi çekici ve güzel bir şekilde sunulan topluluğa yönelik dokümanlar oluşturmaktır.
Proje Planı Sorun Creative Commons WordPress Base temasının şu anda dokümanı yok. Bu durum, temanın topluluk içinde etkili bir şekilde kullanılmasına engel oluyor. Hedefim, tema için eksiksiz bir kullanım kılavuzu oluşturmak ve ayrıca WP Base temasının mevcut kod tabanında soyutlama yaparak temayı daha kolay kullanılabilir hale getirmek.
Çözüm Gatsby gibi modern çerçeveleri kullanarak fütüristik dokümanlar oluşturun. Gatsby, yeni WordPress Temel Tema dokümanlarını önyüklemek için kullanabileceğimiz başlatıcılar içeriyor. Örnek bir başlangıç sayfası, arama motoru optimizasyonu (SEO), markdown ve Algolia ( statik sitelerde arama için entegrasyon amacıyla kullanılan bir araç) desteğiyle birlikte gelen gatsby-gitbook-starter'dır. Buna ek olarak, Gatsby tarafından oluşturulan tüm siteler, uluslararasılaştırma ve erişilebilirliği entegre edecek şekilde kolayca optimize edilebilir. Dokümanları oluştururken mümkün olduğunca sezgisel hale getirmek için şu noktalara dikkat ediyorum: - Dokümanları anlaşılır bir şekilde yazarken belirsizlikten ve aşırı karmaşık teknik jargon kullanımından kaçınıyorum. - Dokümanlara görsel yardımcılar olarak kullanılacak grafik resimler ve medyalar ekleyerek. - Özelleştirmeler gibi yaygın görevlerin nasıl yapılacağını gösteren örnekler kullanarak.
Uygulamayı umduğum soyutlamalar, WP Base Theme'in temel işlevlerinin çoğunun (ör. kancalar) WordPress Yönetici Paneli'nden kullanıcılar tarafından kullanılabilmesini sağlayacak. Ayrıca, WP Base Theme için ayrı bir depoda başlangıç alt teması oluşturmak isterim. Başlangıç olarak çocuk temasına sahip olmak, yeni kullanıcılara daha sorunsuz ve hızlı bir ilk katılım deneyimi sunar. Belgeler tamamlanıp onaylandıktan sonra yayınlanır ve internette barındırılır.
CC WordPress Temel Teması Kullanım Kılavuzu'nun önerilen yapısı: Önerilen dokümanlar aşağıda listelenen farklı bölümlere ayrılacaktır. Önerilen her bölümün altındaki alt liste öğeleri, ilgili bölümlerde bulunacak gerçek içerik hakkında daha fazla ayrıntı sağlar.
Genel Bakış Bölümü: Creative Commons(CC) WordPress Temel Teması'nın tanımını, amaçlarını ve özelliklerini özetleyin. * Tanım: CC WP Base temasını kısaca açıklayın. * Amaç: CC WP Temel Teması'nın amaçlarını/ niyetlerini özetleyin * Özellikler: CC WP Temel Teması'nın özelliklerini özetleyin
Başlangıç Bölümü - Şartlar * CC WordPress Temel Teması'nı yüklemeyle ilgili şartları belirtin. Örneğin: - WordPress sürümü - PHP sürümü - Composer vb. - Yükleme Kılavuzu * Kullanıcıların CC WordPress Teması'nı yüklemek için zip'i nasıl kullanabileceğini belirtin * Kullanıcıların GitHub'dan WP temel temasını kopyalayarak nasıl başlayabileceğini belirtin. * Kullanıcıların projede bağımlılıkları nasıl yükleyebileceklerini ana hatlarıyla belirtme. * Kullanıcıların Queulat bağımlılığını nasıl yapılandırabileceğini açıklayın. * Kullanıcıların temayı yerel WordPress geliştirme ortamlarında nasıl etkinleştirebileceklerini açıklayın.
Kullanım Kılavuzu - Genel bakış * Alt tema terimini açıklayın * Alt tema kullanmanın avantajlarını belirtin. * Kullanıcılara, WP Base temasını düzenlemenin önerilen yolunun alt tema kullanmak olduğunu bildirin. * Kullanıcıların alt tema oluşturabilmesi için WP Temel Teması'nın yüklenmesi ve etkinleştirilmesi gerektiğini vurgulayın.
Çocuk tema kullanma - Kullanıcıların, başlangıç temasını kullanarak WP ana temasının çocuk temasını nasıl oluşturabileceğini açıklayın. Kullanıcıların başlangıç temalarından nasıl alt tema oluşturabileceğini açıklamak için video kullanın.
Özelleştirme Aşağıda listelenen alt bölümlerde, kullanıcıların özelleştirme yapmak için WordPress Özelleştirici'yi ve WordPress Yönetici Paneli'ni nasıl kullanabilecekleri açıklanmaktadır. Açıklamalarımızı daha sezgisel hale getirmek için görsel açıklamaları da kullanmaya başlayacağız. - Site açıklamasını veya sloganını özelleştirin. - Özel Gezinme Menüleri - CSS'yi özelleştirme - Sayfa ekleme - Yayın ekleme - Widget'lar - WordPress Yönetici Paneli'nden widget ekleme ve kaldırma - Özelleştirici'yi kullanarak canlı önizlemeyle widget ekleme
Gelişmiş Özelleştirmeler Bölümü - CSS Özelleştirme Bölümü * Temanın stilini oluşturan bileşenleri açıklayın: - CC Terimleri - Bulma - Sass * Sass'ın projede nasıl ayarlandığını açıklayın. Açıklamada aşağıdakiler hakkında bilgi verilmelidir: (i) sass dosyalarının proje yapısındaki konumu (ii) sass'ı derlemek ve izlemek için kullanılabilecek npm komut dosyaları * Kullanıcıların alt temadaki sass stillerini nasıl özelleştirebileceğini (ör.belirli npm bağımlılıkları yükleyerek) açıklayın * Belirli bileşenlerin stillerini özelleştirmek için bileşen sınıfının (class-component.php) nasıl kullanıldığını açıklayın
- Giriş Cümleleri Bölümü
Genel Bakış
- Kanca terimini açıklayabilme
- Kullanıcıların neden kancalardan yararlanması gerektiğini açıklayın.
- Kullanılabilir kanca türlerini ana hatlarıyla belirtin.
İşlemleri kullanma
- WP Base temasında ve konumlandırmasında kullanılabilen işlemleri listeleyin
- Bu işlemlerin nasıl uygulanabileceğini açıklayın.
*Filtreleri kullanma - Temada bulunan filtreleri listeleyin ve bunların nasıl uygulanabileceğini açıklayın
Tema bölümünü güncelleme: Kullanıcıların temayı nasıl güncelleyebileceklerini açıklayın.
Lisanslama Bölümü * Projenin lisansını ve CC WP Base Teması'nı kişisel projelerinde kullanmak isteyen kullanıcılar için ne anlama geldiğini açıklayın.
Katkı bölümü * Ayrıntılı bir katkı rehberi ekleyin * Davranış Kuralları'nı özetleyin * Topluluk: Creative Commons topluluk kanalları ve katkıda bulunanların bu kanallara nasıl katılabileceği hakkında bilgi verin.