Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- ScummVM
- Teknik yazar:
- Caddi
- Proje adı:
- Belgeler Portalını Başlat
- 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ümü oluşturulmuş son kullanıcı dokümanları üretmek için.
- Belgelerin yeni başlayanlar için kolay anlaşılır olması, teknoloji konusunda birikimli kullanıcıları övmemesi gerekir.
- Statik site oluşturucu kullanarak belge portalı oluşturmak için.
- İleride açık kaynak olarak katkıda bulunacak kullanıcılar için şablonlar ve ayrıntılı "nasıl yapılır" talimatları oluşturarak geleceğe hazır son kullanıcı dokümanları elde edin.
Mevcut durum:
- Mevcut ScummVM belgeleri birden fazla kaynağa yayılmıştır.
- Bilgiler bulmak zordur ve genellikle yinelenir; anlaşılması güç sayfalarda kaybolmak kolaydır.
- Hangi bilgilerin güncel, hangilerinin eski olduğunu bilmek zordur.
- Bazı bilgiler eksik veya tamamlanmamış.
Sorunu çözme:
Önerilen doküman 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ı
| |-- Genel 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 olabildiğince hızlı başlangıç yapmak için hızlı bir başlangıç kılavuzu ararlar. ScummVM'nin yüklenmesi bazı platformlarda 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 nasıl yüklenir, eklenir ve başlatılır.
ScummVM'yi yükleme:
Yüklemenin sezgisel olmadığı veya kullanıcının güçlü bir teknik temele sahip olmadığı durumlarda kullanıcının, ScummVM'yi desteklenen platformlardan herhangi birine yüklemek için kapsamlı bir kılavuza ihtiyacı vardır.
Her kapsamlı kurulum sayfası aşağıdakileri kapsamalıdır:
- Tüm sistem gereksinimleri/ön koşulları.
- ScummVM'nin uygun sürümünü indirme.
- ScummVM nasıl yüklenir?
- Özellikle de oyunun tasarlanmadığı platforma oyun 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ığı.
- Hem genel hem de 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 ayarlar yapmak için kendilerine sunulan seçenekler hakkında 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üklemeyle ilgili ilginç bilgiler - Gereken ek dosyalar - Olağan dışı veya farklı kontroller
- Bilinen sorunlar:
Bu bölüm, sürüme özgü bilinen hataları içermelidir.
- Sürüm notları:
Dokümanlarımız sürüm halinde yayınlanacak olsa da Sürüm Notları bölümünün olması en son sürümdeki değişikliklerin bir özetini sunma açısından faydalı olabilir. Bu, yeni desteklenen oyunlar veya yeni motorlarla ilgili bilgiler gibi şu anda bu dokümanın kapsamı dışında olan bazı alanları içerebilir.
Saldırı planı:
Yükleme ScummVM sayfaları için bir şablon oluşturarak başlamayı öneriyorum, çünkü bu şablon bana gerekli olan bilgileri bağlantı noktası sorumlularından/geliştiricilerinden almanın en kolay yolu olacaktır (özellikle de yeterli bilgi yoksa veya mevcut değilse). Mevcut belgelerden edindiğim tüm bilgileri önceden dolduracağım. Daha sonra bu bilgilerin eksiksiz ve doğru olup olmadığı kontrol edilebilir veya gerektiği gibi eklenebilir.
Ardından mevcut dokümanları (BENİOKU, wiki ve web sitesi) tarayacağım. Kursa devam ettikçe her bölümü gerektiği gibi yeniden yazıp ilgili bölümlere ekleyeceğim ve tüm bilgileri yeni portala aktaracağım. Ayrıca, portal kullanıma sunulduktan sonra ikileme, çelişki veya başka anormallikler yaşanmaması için hangi bilgilerin nereden alındığını da not edeceğim.
Tüm eksik bilgileri sağlamak için mentorlar, geliştiriciler, liman sorumluları ve diğer konu uzmanlarıyla birlikte çalışarak her sayfanın mümkün olduğunca güncel ve kapsamlı olmasını sağlayacağım.
İş birliği amacıyla ve mentorlardan onay almak kaydıyla, devam eden çalışmalar portalının yazma süreci boyunca ScummVM topluluğunun erişimine açılmasını, böylece gerçek zamanlı geri bildirim almalarını ve süreç boyunca hiçbir şeyi kaçırmamalarını sağlamak istiyorum.
Bu çalışma gövdesinde ve bundan sonraki tüm dokümanlarda tutarlılık sağlamak için Google geliştirici dokümanları stil kılavuzu gibi bir stil kılavuzu kullanmanızı öneririm.
Konunun daha iyi anlaşılmasını sağlamak için mümkün olduğunda ekran görüntüsü, gif ve diğer görsel yardımcıları kullanacağım.
Önerilen zaman çizelgesi:
Topluluk bağları 17 Ağustos - 13 Eylül 2020
Projenin vizyonunu netleştirmek ve belge yapısı ile içeriği gibi ayrıntıları son haline getirmek için danışmanlarla ve ScummVM topluluğuyla konuşmaya zaman ayırmaya devam edin.
1. Hafta 14 Eylül - 20 Eylül
- Platforma özel yükleme sayfaları için şablon oluşturun.
- Şablonları mevcut bilgilerle önceden doldurun ve daha fazla bilgi için ilgili bağlantı noktası yöneticilerine/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 kullanarak: - Arayüz - Global ayarlar ScummVM'yi Yükleme: - Platforma özel yükleme kılavuzları tamamlanmış şablonlar olarak bana gönderilir.
4. Hafta 5 Ekim - 11 Ekim
ScummVM'yi kullanarak: - Oyun ayarları - Klavye kısayolları ScummVM'yi yükleme: - Tamamlanmış şablonlar olarak platforma özel yükleme kılavuzları bana gönderilir
5. Hafta 12 Ekim - 18 Ekim
Gelişmiş seçenekler: - Bulut ve LAN - Harita Oluşturmayı Kontrol Etme ScummVM'yi Yükleme: - Tamamlanan şablonlar içeren platforma özel yükleme kılavuzları bana gönderilir
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önderilirken 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 olarak bulunduğum platforma özel yükleme kılavuzları bana gönderilir
8. Hafta 2 Kasım - 8 Kasım
Yardım: - SSS - Kişiler - Bilinen sorunlar
ScummVM'yi yükleme: - Tamamlanan şablonlar bana geri gönderilirken platforma özel yükleme 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ış platform kılavuzlarını tamamlayın.
10. Hafta 16 Kasım - 22 Kasım
- Son düzenleme, gözden geçirme ve portalla ilgili tüm kararları kesinleştirme (ör. kenar çubuğu gezinme, tema/CSS ayarları vb.)
- Tüm bağlantıların beklendiği gibi çalıştığından emin olun.
- Resimlerin/gif'lerin doğru şekilde görüntülendiğ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 gereksiz bilgileri kaldırın.