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:
- WordPress
- Teknik yazar:
- tacitonic
- Projenin adı:
- Eksiksiz ve Yenilenmiş Bir Doküman Stil Kılavuzu
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
Özet:
WordPress, küresel topluluklara erişilebilirlik, performans, güvenlik ve kullanım kolaylığını vurgulayan yazılımlarla hizmet sunmayı amaçlayan, kâr amacı gütmeyen küresel bir yazılım kuruluşudur. WordPress'in amacı, web'de yayınlama ve açık kaynak yazılımı demokratikleştirmeyi amaçlamaktadır. Dijital çağımızda web siteleri, bir kuruluşun/kişinin internetteki yüzüdür. WordPress, yazılımıyla internetin% 35'ini oluşturan yüz milyonlarca kullanıcıya verimli bir şekilde hizmet verme konusunda büyük bir görev üstlenmektedir. Bu kullanıcılara daha verimli bir şekilde hizmet vermek için dokümanların gerekli olduğu kanıtlanmıştır ve çoğu geliştirici, yönetici ve son kullanıcı tarafından kullanılır. Bu nedenle belgeleme, WordPress ekosisteminin temel unsurlarından biri olabilir. Mevcut WordPress dokümanları, yayınlama için evrensel ve birleşik bir kurallar ve stil yönergeleri grubu içermiyor. Bu teklifin amacı, WordPress belgeleri için evrensel olarak uygulanabilecek, eksiksiz ve yenilenmiş bir belge stili kılavuzu oluşturmaktır. Proje fikri, tasarım ve stil yönergelerinin tüm yönlerini (ör. anlambilim, söz dizimi, dil bilgisi kuralları, noktalama işaretleri, geliştirmeye özgü kurallar, tasarım özellikleri ve biçimlendirme ayrıntıları) bir araya getirmeyi içeriyor. Ayrıca ses, üslup, zaman ve konuşmanın tüm kısımları gibi dil kurallarını ve adlandırma kurallarını içerir. Kullanılacak araçlar, diller ve platformlar WordPress içerik yönetim sistemi, GitHub ve Markdown olacak. Ayrıca, PHP/MySQL, HTML/CSS ve JavaScript'i de kapsayabilecek.
Proje Planı:
WordPress Dokümanları Stil Kılavuzlarının Mevcut Durumu: WordPress Dokümanlar Ekibi, yayınlanma yönergeleri için açıklanmayan ancak oy birliğiyle kabul edilmiş bir metodoloji uyguluyor. Ancak zaman zaman bazı unsurlar varsayılır ve süreç spekülatif hale gelir. WordPress için makale yazma ve yayınlama amacıyla sabit bir standart ve ölçüt yoktur. Dokümanlar ekibi, projeye özel stil yönergeleri yazmıştır ancak bunların hiçbiri evrensel olarak geçerli değildir. Mevcut stil kurallarının çoğu tek bir kılavuzda birleştirilmemiş veya desteği sonlandırılmış olup güncellenmesi gerekiyor. Dolayısıyla, WordPress belgelerini standartlaştırmak için birleşik bir stil kılavuzu tasarlayıp geliştirmeniz gerekir.
Hedefler:
İnternetteki web sitelerinin% 35'inden fazlası WordPress ile çalışır. Bu da milyonlarca geliştiricinin ve son kullanıcının WordPress'in etkileyici işlevlerinden yararlandığını gösterir. Belgeler, bu geliştiricilerin ve kullanıcıların, aksaklıklar yaşansa bile bu işlevleri sorunsuz bir şekilde yerine getirmelerine yardımcı olan önemli bir unsurdur. Bu proje teklifinin genel amacı bir tasarım ve stil kılavuzunu standart hale getirmek, mevcut stil kılavuzlarını birleştirmek ve güncellemek, ayrıca WordPress belgeleri için yeni düzenlemeler ve spesifikasyonlar eklemektir. Bu sayede WordPress dokümanlarında kullanım kolaylığı, sadelik ve tekdüzelik sağlanabilir.
Uygulama:
Bu proje için mentor (Jon Ang) tarafından önerilen 4 aşamaya göre yaklaşılabilir: Keşif, Tanımlama, Uygulama ve Bakım aşaması. Proje başlamadan önce, staj öncesi dönemde, mentorumla birlikte çalışacağım ve gelecek takvim ve teslimatlarıma göre uygun bir zaman çizelgesi ve takvim hazırlayacağım. WordPress sistemi ve bu projenin çalışma protokolleri hakkında daha fazla bilgi edineceğim.
Staj başladığında planın özetini danışman hocamla tartışıp taslak haline getireceğim. Gereklilikler ve ihtiyaçlar belirlenir. İlk olarak belge akışını ve kullanıcı etkileşimi sürecini özetleyeceğim. Ardından her bölümün, kategorinin ve bileşenin düzeni için taslak çizimler oluşturulur. Bu düzenler daha sonra danışmanım tarafından incelenir. Gerekirse düzenler yeniden tasarlanacak ve bazı bileşenler eklenip kaldırılacak. Ardından, arayüz akışının kullanılabilirliğini ve uygulanabilirliğini belirlemek için kullanıcı araştırması yapacağım. Ardından, doküman stil kılavuzu bölüm başına uygulanacaktır (aşağıdaki şemada gösterildiği gibi). Rehberimize eklemek için açık kaynak veya Creative Commons lisansları kapsamındaki diğer kuruluşların stil kılavuzlarına da referans verilebilir. Bu süre zarfında kullanılabilirlikle ilgili herhangi bir sorun oluşursa bunları yeniden tasarlayacağım.
Stil kılavuzu tamamlanıp HelpHub ile entegre edildikten sonra test ve optimizasyonlar yapılacaktır. Tüm güvenlik açıkları, gereksiz öğeler veya bileşenler düzeltilir. Kullanıcı arayüzü ve kod testi yapılır ve gerekirse istenmeyen hatalar düzeltilir. Dil, dil bilgisi, yazım, noktalama vb. açısından stil kılavuzunun tamamı için son bir kalite kontrolü yapılır.
Öngörülemeyen gecikmeler nedeniyle bekleyen görevler, tampon dönemde tamamlanır. Projenin ilerleyen aşamalarında uygulanabilir olduğu belirlenen ek işlevler veya özellikler, nihai test tamamlandıktan sonra uygulanabilir. Bir dağıtım planı oluşturulur ve bitmiş ürün gönderilir.
Araçlar ve Metodolojiler:
Dokümanlar, Google Dokümanlar gibi ortak çalışmaya dayalı bir platformda derlenir ve düzenlenir. GitHub üzerinden yayınlanması gerekiyorsa Markdown veya GitHub Flavored Markdown gibi işaretleme dilleri de uygulanabilir. Tasarım ve stil standartları için açık kaynak stil yönergelerine de referans verilebilir. Son olarak, tamamlanan doküman WordPress kullanılarak biçimlendirilir ve yayınlanır.
Bileşen tablosu:
Bu, Stil Kılavuzu'nda uygulanabilecek bileşenlerin kapsamlı bir listesidir. Doküman Kuralları - Erişilebilirlik, Doküman Yapısı, Kodlama, Harici Kaynaklar, Gerçekler, Yazı Tipleri, Küresel Kitle, Kapsayıcılık, Yasallık, Çok Platformlu Erişilebilirlik, Anlaşılır, Aşırı İddialar Yok, Sayfa Düzeni, Politik Doğruluk, Protokoller, Güvenlik, Cümle Yapısı, Özet Yazım, Ton ve Stil, Tarafsız
Dil ve Dil Bilgisi - Kısaltmalar ve kısaltmalar, Onaylama ve olumsuzlama, Makaleler, Büyük harf kullanımı, Cümle, Doğrudan/dolaylı konuşma, Birinci/İkinci/Üçüncü şahıs, Cinsiyet, Sözlük, Adlar, Ön ekler ve son ekler, Edat, Hitaplar, Referans verme, Argo ve jargon, Yazım, Teknik terimler, Zaman, Fiiller, Ses
Noktalama - Kesme İşareti ve Tırnak İşareti, İki Nokta ve Noktalı Virgül, Virgül, Elips, Ünlem İşaretleri, Kısa Çizgiler ve Tireler, Parantezler, Noktalar, Soru İşaretleri, Eğik Noktalar
Biçimlendirme: Özet, Giriş, Önsöz, Marka Adları, Ürün Adları, Altyazılar, Kod Snippet'leri, Kod Blokları, Tarih ve Saat, Saat Dilimleri, Yerler, Para Birimleri, Dosya Adları, Dipnotlar, Başlıklar ve Alt Başlıklar, Vurgulama (Kalın, İtalik, Alt Çizili, Üst Çizili, Alıntı), Girintili, Dizin, Bağlantılar ve URL'ler, Listeler, Madde İşaretli Listeler, Numaralandırma, Medya (Resimler, Videolar) ve Görseller, Notlar, Uyarılar, İpuçları, Sayılar ve Telefon Numaraları, Çok Dilli Yazarlar, Çeviri, Dil Yazı Tipleri, Boşluk, Tablolar, Metin, Ticari Markalar, Telif Hakları, Patentler, Alıntılar, Eğitimler ve Prosedürleri, Kullanıcı Arayüzü Öğeleri, Ölçü Birimleri
Kullanıcı Arayüzü - Etkinlikler, Düğmeler, Kod Snippet'leri, Kod Blokları, Komut Satırı Arayüzü, İletişim Kutuları, Menüler ve Açılır Menüler, Pop-up'lar ve Uyarılar, Sekmeler, Terminoloji, Kullanıcı arayüzü öğeleri, Pencereler
Kod - CSS, HTML, JS, Markdown, MySQL, PHP, Söz dizimi, XML
Kelime Kullanımı Sözlüğü/Terimler Sözlüğü - A'dan Z'ye