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:
- ScummVM
- Teknik yazar:
- Caddi
- Projenin adı:
- Bir Belge Portalı Başlatın
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Hedefler:
- Farklı kaynaklardan gelen büyük miktarda bilgiyi birleştirerek ve bilgileri netlik, tutarlılık ve eksiksizlik için yeniden yazarak yüksek kaliteli, sürümlü son kullanıcı dokümanları üretmek için.
- Belgelerin yeni başlayanlar için kolay anlaşılır olması, teknoloji meraklısı kullanıcıları desteklememesi gerekir.
- Statik site oluşturucu kullanarak belge portalı oluşturmak için:
- Gelecekteki açık kaynak katkıda bulunanlar için şablonlar ve ayrıntılı nasıl yapılır talimatları oluşturarak geleceğe hazır son kullanıcı dokümanları için.
Mevcut durum:
- Mevcut ScummVM belgeleri birden fazla kaynağa yayılmıştır.
- Bilgi bulmak zordur ve genellikle yinelenir; belirsiz sayfalarda kaybolmak çok kolaydır.
- Hangi bilgilerin güncel, hangilerinin eski olduğunu bilmek zordur.
- Bazı bilgiler eksik veya yetersiz.
Sorunu çözme:
Önerilen belge yapısı:
Açılış Sayfası
|-- Başlarken
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (platform)
|-- ScummVM'yi kullanma
| |-- Başlatıcı
| |-- Global ayarlar
| |-- Oyun ayarları
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- Müzik ve ses
|-- Yardım
| |-- SSS
| |-- Kişiler
| |-- Bilinen sorunlar
| -- Reporting a bug
|-- Game Notes-- Sürüm Notları
- Başlarken:
Yeni kullanıcılar genellikle en hızlı şekilde işe koyulmak için hızlı bir başlangıç kılavuzu ararlar. ScummVM'nin kurulumu bazı platformlar için karmaşık olabilir ancak bir bilgisayara yüklenmesi değildir.
Hızlı başlangıç kılavuzu aşağıdaki konuları kapsamalıdır:
- ScummVM'yi Windows, Mac ve Linux'a yükleme.
Oyun yükleme, ekleme ve başlatma.
ScummVM'yi yükleme:
Yüklemenin sezgisel olmadığı veya kullanıcının güçlü bir teknik temele sahip olmayabileceği durumlarda, kullanıcının ScummVM'yi desteklenen platformlardan herhangi birine yüklemek için kapsamlı bir rehbere ihtiyacı vardır.
Her kapsamlı yükleme sayfası aşağıdaki bilgileri kapsamalıdır:
- Tüm sistem gereksinimleri/ön koşulları.
- ScummVM'nin uygun sürümünü indirme
- ScummVM nasıl yüklenir?
- Oyunları, seçilen platforma (özellikle de oyunun tasarlandığı platform dışında) yükleme.
ScummVM'yi başlatma, oyun ekleme ve kullanıma sunma.
ScummVM'yi kullanma:
Kullanıcıların, ScummVM'nin nasıl kullanılacağını açıklayan referans belgelerine ihtiyacı vardır.
Referans belgelerinde şu konular yer almalıdır:
- Başlatıcı arayüzü; her bir pencerenin ve sekmenin nasıl göründüğü ve nasıl çalıştığı.
- Genel ve oyuna özel kullanılabilir ayarların açıklaması
Klavye kısayolları/kısayol tuşları.
Gelişmiş seçenekler:
İleri düzey kullanıcılar, oyunlarının çalışma şeklinde ince ayar yapmak için kullanabilecekleri seçeneklerle ilgili daha fazla teknik bilgiye ihtiyaç duyar.
- Oyun notları:
Aşağıdakiler dahil ancak bunlarla sınırlı olmamak üzere kullanıcının bilmesi gereken, oyuna özel bilgiler: - Yüklemenin ilginç özellikleri - Gereken ek dosyalar - Olağan dışı veya farklı kontroller
- Bilinen sorunlar:
Bu bölüm, sürüme özgü tüm bilinen hataları içermelidir.
- Sürüm notları:
Dokümanlarımız ayrı sürüm olarak hazırlanmış olsa da, Sürüm Notları bölümünün olması son sürümdeki değişikliklerin bir özetini sağlamak için yararlı olabilir. Bunlar, yeni desteklenen oyunlar veya yeni motorlar hakkında bilgiler gibi şu anda bu dokümanın kapsamı dışında kalan bazı alanları içerebilir.
Saldırı planı:
Yükleme ScummVM sayfaları için bir şablon oluşturarak başlamayı öneriyorum. Bu, bağlantı noktası sorumlularından/geliştiricilerinden (özellikle de bu bilgilerin yeterli olmadığı veya bulunmadığı durumlarda) ihtiyacım olan bilgileri almam için en kolay yol olacak. Mevcut belgelerden edindiğim tüm bilgileri önceden dolduracağım. Bu bilgiler daha sonra eksiksizlik, doğruluk ve para birimi açısından kontrol edilebilir veya gerektiğinde eklenebilir.
Ardından mevcut dokümanları (README, wiki ve web sitesi) tarayacağım. İlerledikçe her bölümü yeniden yazıp gerekli yerlere ekleyeceğim ve tüm bilgileri yeni portala aktaracağım. Ayrıca, portal kullanıma sunulduktan sonra iki katına çıkması, çelişkiler veya başka anormalliklerin yaşanmayacağından emin olmak için hangi bilgilerin nereden alındığını not edeceğim.
Tüm eksik bilgileri sağlayıp her sayfanın mümkün olduğunca güncel ve kapsamlı olmasını sağlamak için mentorlar, geliştiriciler, liman sorumluları ve diğer konu uzmanlarıyla birlikte çalışacağım.
İşbirliği amacıyla ve mentorlardan onay alarak ScummVM topluluğunun yazma süreci boyunca devam eden portala erişebilmesini, böylece gerçek zamanlı geri bildirim alabilmesini ve süreç boyunca hiçbir şeyin gözden kaçmamasını sağlamak istiyorum.
Bu çalışmada ve bundan sonraki tüm dokümanlarda tutarlılık sağlamak için Google geliştirici belgeleri stil kılavuzu gibi bir stil kılavuzu kullanmanızı öneririm.
Konuyu daha iyi anlayabilmek için mümkün olduğunda ekran görüntüleri, gif'ler ve diğer görsel yardımcılardan yararlanırım.
Önerilen zaman çizelgesi:
Topluluk bağları 17 Ağustos - 13 Eylül 2020
Projenin vizyonunu hassaslaştırmak ve belge yapısı ile içeriği gibi ayrıntıları son haline getirmek için danışmanlarla ve daha geniş kapsamlı ScummVM topluluğuyla görüşmeye zaman ayırmaya devam edin.
1. Hafta 14 Eylül - 20 Eylül
- Platforma özel yükleme sayfaları için bir şablon oluşturun.
- Şablonları mevcut bilgilerle önceden doldurun ve daha fazla bilgi için uygun taşıma sorumlularına/geliştiricilerine dağıtın.
2. Hafta 21 Eylül - 27 Eylül
- Yeni doküman portalını kurun.
3. Hafta 28 Eylül - 4 Ekim
ScummVM'yi kullanma: - Arayüz - Global ayarlar ScummVM'yi yükleme: - Tamamlanmış şablonlar olarak platforma özel yükleme kılavuzları bana iade ediliyor.
4. Hafta 5 Ekim - 11 Ekim
ScummVM'yi kullanma: - Oyun ayarları - Klavye kısayolları ScummVM'yi yükleme: - Tamamlanmış şablonlar olarak platforma özel yükleme kılavuzları bana veriliyor
5. Hafta 12 Ekim - 18 Ekim
Gelişmiş seçenekler: - Bulut ve LAN - Haritalama Kontrolü ScummVM'yi Yükleme: - Tamamlanmış şablonlar olarak platforma özel yükleme kılavuzları bana döndürülüyor
6. Hafta 19 Ekim - 25 Ekim
Gelişmiş seçenekler: - Yapılandırma - Komut satırı seçenekleri ScummVM'yi yükleme: - Tamamlanan şablonlar bana geri gönderildi olarak platforma özel yükleme kılavuzları
7. Hafta 26 Ekim - 1 Kasım
Gelişmiş seçenekler: - Grafikler - Ses ScummVM'yi Yükleme: - Tamamlanan şablonlar bana geri gönderilir, platforma özel yükleme rehberleri
8. Hafta 2 Kasım - 8 Kasım
Yardım: - SSS - Kişiler - Bilinen sorunlar
ScummVM'yi yükleme: - Tamamlanmış şablonlar bana geri gönderilirken platforma özel kurulum kılavuzları
9. Hafta 9 Kasım - 15 Kasım
Yardım: - Hata bildirme - Oyun notları - Sürüm notları
ScummVM'yi yükleme: - Henüz tamamlanmamış tüm platform kılavuzlarını tamamlayın.
10. Hafta 16 Kasım - 22 Kasım
- Son düzenleme, gözden geçirme ve kenar çubuğuyla gezinme, tema/CSS değişiklikleri gibi portalla ilgili tüm kararları kesinleştirme.
- Tüm bağlantıların beklendiği gibi çalıştığından emin olun.
- Resimlerin/gif'lerin düzgün görünüp görünmediğini kontrol edin.
11. Hafta 23 Kasım - 30 Kasım
- Bekleyen tüm öğeleri tamamlayın ve portalı resmi olarak kullanıma sunun.
- Portal kullanıma sunulduktan sonra mentorlara danışarak diğer kaynaklardan gelen gereksiz bilgileri kaldırın.