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:
- 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'nin teknik yazar başvurusu aşamasında Creative Commons WordPress temel tema doküman projesinin mentoru olan Hugo Solar ile birkaç görüşme yaptım.
Onunla ilk temasta geçtiğimde, WordPress temel tema kullanım kılavuzunu oluşturma hedeflerini anlamak için yardım istedim. Çok yardımcı oldu ve beni hızla projeye katılmaya yönlendirdi. Bundan sonra gerçekleştirdiğimiz tüm arka arkaya etkileşimler, CC WordPress Base tema dokümanlarının hedeflerini hassaslaştırmaya yönelikti.
Bir aşamaya geldiğimde projenin gerekliliklerini ve hedeflerini anladığımı hissettim. Ardından CC WordPress Base Theme Kullanım Kılavuzu için taslak bir teklif oluşturmaya karar verdim.
Teklif, stajyer başvuruları için Creative Commons resmi şablonu kullanılarak oluşturulmuştur. Proje özeti, önerilen proje yapısı ve yeni WordPress Base Theme dokümanlarının düzeni hakkında bilgilerin yanı sıra belge oluşturma aşaması için zaman çizelgeleri ve teslimatlar hakkında bilgi sağlar.
Ardından Hugo Solar taslak teklifimi inceledi ve iyileştirmeler yapmam için bana geri bildirimde bulundu. Bu süreç boyunca projeyle ilgili soruları yanıtlamak için her zaman müsaitti.
Verilen geri bildirimi uyguladım. D&I Rozetleri Oluşturmaya yönelik nihai önerime aşağıdaki bağlantıdan Google Dokümanı olarak ulaşabilirsiniz.
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 teklif, 28 Haziran 2020
Proje Özeti Bu projenin asıl amacı, Creative Commons WordPress Base Theme için, topluluğa yönelik zengin, sezgisel, ilgi çekici ve güzelce sunulmuş dokümanlar oluşturmaktır.
Proje Planı Sorun Şu anda Creative Commons WordPress Base temasıyla ilgili herhangi bir belge yoktur. Bu durum, temanın topluluk içinde etkili bir şekilde kullanılmasını engeller. Tema için eksiksiz bir kullanım kılavuzu oluşturmayı ve ayrıca kullanımını kolaylaştırmak için WP Base temasının mevcut kod tabanına soyutlamaları eklemeyi amaçlıyorum.
Çözüm Gatsby gibi modern çerçeveleri kullanarak fütüristik dokümanlar oluşturun. Gatsby, yeni WordPress Base Theme dokümanlarını geliştirmek için kullanabileceğimiz başlatıcılar sunuyor. Örneğin, arama motoru optimizasyonu (SEO), Markdown ve Algolia ( statik sitelerde aramayı entegre etmek için kullanılan bir araç) desteğiyle birlikte kullanıma hazır olarak sunulan gatsby-gitbook-starter aracı. Buna ek olarak, Gatsby tarafından oluşturulan siteler uluslararasılaştırmayı ve erişilebilirliği entegre etmek için kolayca optimize edilebilir. Bu belgeleri oluştururken amacım, dokümanları mümkün olduğunca sezgisel hale getirmektir. Bunun için: - dokümanları kolay anlaşılır bir şekilde yazma, belirsizliği ve aşırı karmaşık teknik jargon kullanmamaya özen gösterir. - Eğitime yardımcı görsel araç olarak kullanılmak üzere dokümanlara grafik resimler ve medya öğeleri ekleyerek. - Özelleştirmeler gibi genel görevlerin nasıl yürütüleceğini gösteren örnekler kullanma.
Uygulaymayı umduğum soyutlamalarla, WP Temel Teması'nın (ör. kancalar) temel işlevlerinin çoğundan WordPress Yönetici Paneli'nde kullanıcılar tarafından yararlanılabilmesini sağlamayı umuyorum. Ayrıca, ayrı bir depoda WP Temel Teması için bir başlangıç çocuk teması oluşturmak istiyorum. Başlangıç alt temanın olması, yeni kullanıcılar için daha sorunsuz ve hızlı bir ilk katılım deneyimi sağlar. Bu belgeler tamamlanıp onaylandıktan sonra online olarak yayınlanır ve barındırılır.
CC WordPress Temel Tema Kullanım Kılavuzu için önerilen yapı - Önerilen dokümanlar, aşağıda listelenen farklı bölümlere ayrılacaktır. Önerilen her bölümün altındaki öğeler, ilgili bölümlerde bulunacak içerikler hakkında daha ayrıntılı bilgi verir.
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 Temel Temasını kısaca açıklayın. * Amaçlar: CC WP Temel Temasının amaçlarını/ amaçlarını belirtin * Özellikler: CC WP Temel Temasının özelliklerini genel hatlarıyla belirtin
Başlarken Bölümü - Koşullar * CC WordPress Temel Teması'nı yükleme şartlarını özetleyin. - 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ı klonlayarak nasıl başlangıç yapabileceklerini belirtin. * Kullanıcıların projede bağımlılıkları nasıl yükleyebileceğini ana hatlarıyla belirtme. * Kullanıcıların bağımlılık Queulat'ı nasıl yapılandırabileceğini açıklayabileceksiniz. * Kullanıcıların temayı yerel WordPress geliştirme ortamlarında nasıl etkinleştirebileceklerini açıklayın.
Kullanım Kılavuzu - Genel Bakış * Çocuk teması terimini açıklayın * Alt tema kullanmanın avantajlarını belirtin. * Kullanıcıları WP Base temasını düzenlemenin önerilen yolunun Çocuk Teması aracılığıyla düzenlemek olduğu konusunda bilgilendirin. * Kullanıcıların alt tema oluşturabilmesi için WP Base Theme'in yüklenmesi ve etkinleştirilmesi gerektiğini vurgulayın.
Çocuk Teması Kullanma - Kullanıcıların bir başlatıcı kullanarak WP Temel Teması'nın çocuk temasını nasıl oluşturabileceklerini açıklayın. Kullanıcıların daha en başından nasıl alt tema oluşturabileceklerini açıklamak için bir video kullanın.
Özelleştirme Aşağıdaki alt bölümlerde, kullanıcıların özelleştirmeler yapmak için WordPress Özelleştirici ve WordPress Yönetici Paneli'ni nasıl kullanabileceklerini özetledik. Açıklamalarımızı daha kolay anlaşılır hale getirmek için grafik resimler de kullanacağız. - Site açıklamasını veya sloganı özelleştirebilirsiniz. - Ö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 - Canlı önizlemeye sahip Özelleştirici'yi kullanarak widget ekleme
Gelişmiş Özelleştirmeler Bölümü - CSS Bölümü Özelleştirmesi * Temanın stilini oluşturan bileşenleri açıklayın: - CC Kelime Bilgisi - Bulma - Sass * Sass'ın projede nasıl oluşturulduğunu açıklayın. Açıklama, aşağıdakilerle ilgili bilgileri içermelidir: (i) Sass dosyalarının proje yapısındaki konumu (ii) SAss oluşturmak ve izlemek için kullanılabilecek npm komut dosyaları * Kullanıcıların, alt temada, belirli npm bağımlılıklarının kurulumu aracılığıyla, sass stillerini nasıl özelleştirebileceklerini açıklama * Bileşen stillerinin özelleştirilmesi için (sınıf-php) bileşen sınıfının nasıl kullanıldığını açıklayın.
- Kanca Bölümü
Genel bakış
- Kanca terimini açıklayabilme
- Kullanıcıların neden kancalardan yararlanmaları gerektiğini açıklayın.
- Kullanabileceğiniz kanca türlerini özetleyin.
İşlemler'i kullanma
- WP Base temasındaki işlemleri ve konumunu listelemek
- Bu eylemlerin nasıl uygulanabileceğini açıklayın.
*Filtreleri Kullanma - Temada kullanılabilen filtreleri listeleyin ve bunların nasıl uygulanabileceğini açıklayın
Tema bölümünün güncellenmesi: - Kullanıcıların temayı nasıl güncelleyebileceklerini açıklayın.
Lisanslama Bölümü * CC WP Temel Teması'nı kişisel projelerinde kullanmak isteyebilecek kişilere projenin lisanslanması ve bunun ne anlama geldiği açıklayın.
Katkıda Bulunma Bölümü * Ayrıntılı bir katkıda bulunan kılavuz ekleyin * Davranış Kurallarını Ana hatlarıyla belirtin * Topluluk: Creative Commons topluluk kanalları ve katkıda bulunanların nasıl katılabileceği hakkında bilgi verin.