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:
- ScummVM
- Teknik yazar:
- Cadi
- Proje adı:
- Belge Portalı oluşturma
- Proje uzunluğu:
- 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 eksiksiz olması için yeniden yazarak yüksek kaliteli, sürümlü son kullanıcı dokümanları oluşturmak.
- Yeni başlayanlar için kolay anlaşılır olan belgeler, teknoloji konusunda bilgili kullanıcılara yönelik övgüler taşımadan önce kolayca anlaşılabilmelidir.
- Statik site oluşturucu kullanarak doküman portalı oluşturmak için.
- Gelecekte açık kaynak katkıda bulunacak kullanıcılar için şablonlar ve ayrıntılı kullanım talimatları oluşturarak son kullanıcı dokümanlarını geleceğe hazır hale getirmek.
Mevcut durum:
- Mevcut ScummVM dokümanları birden fazla kaynağa yayılmıştır.
- Bilgilerin bulunması zordur ve genellikle kopyadır. Belirsiz sayfalarda kaybolmak kolaydır.
- Hangi bilgilerin güncel, hangilerinin güncel olmadığını bilmek zordur.
- Bazı bilgiler eksik veya tamamlanmamış.
Sorunu düzeltme:
Ö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 mümkün olduğunca hızlı bir şekilde başlamak için hızlı başlangıç kılavuzu arar. ScummVM'i bazı platformlara yüklemek karmaşık olsa da bilgisayara yüklemek kolaydır.
Hızlı başlangıç kılavuzu aşağıdakileri içermelidir:
- ScummVM Windows, Mac ve Linux'a nasıl yüklenir?
Oyun yükleme, ekleme ve başlatma.
ScummVM'yi yükleme:
Yüklemenin sezgisel olmadığı veya kullanıcının teknik bilgisinin yeterli olmadığı durumlarda, kullanıcının desteklenen platformlardan herhangi birine ScummVM yüklemek için kapsamlı bir kılavuza ihtiyacı vardır.
Her kapsamlı yükleme sayfası aşağıdakileri içermelidir:
- Sistem gereksinimleri/önkoşullar.
- ScummVM'nin uygun sürümünü indirme.
- ScummVM'i yükleme.
- Oyunları, özellikle oyunun tasarlandığı platform olmayan seçili platforma yükleme
ScummVM'i başlatma, oyun ekleme ve oyun başlatma.
ScummVM'yi kullanma:
Kullanıcıların, ScummVM'nin nasıl kullanılacağını açıklayan referans belgelere ihtiyacı vardır.
Referans dokümanları aşağıdakileri kapsamalıdır:
- Başlatıcı arayüzü; her pencere ve sekmenin görünümü ve işleyiş şekli.
- Hem global hem oyuna özel kullanılabilir ayarlarla ilgili açıklama.
Klavye kısayolları/hızlı tuşlar.
Gelişmiş seçenekler:
İleri düzey kullanıcılar, oyunlarının çalışma şeklini ayarlamak için kullanabilecekleri seçenekler hakkında daha teknik bilgilere ihtiyaç duyar.
- Oyun notları:
Kullanıcının bilmesi gereken oyuna özgü bilgiler. Örneğin: - Yüklemeyle ilgili özellikler - Gerekli ek dosyalar - Olağan dışı veya farklı kontroller
- Bilinen sorunlar:
Bu bölümde, sürüme özgü bilinen tüm hatalar yer almalıdır.
- Sürüm notları:
Dokümanlarımız sürümlere ayrılacak olsa da en son sürümdeki değişikliklerin özetini sunmak için bir Sürüm Notları bölümü eklemek yararlı olabilir. Şu anda bu dokümanların kapsamı dışında olan bazı alanlar (ör. yeni desteklenen oyunlar veya yeni motorlarla ilgili bilgiler) bu kapsamda yer alabilir.
Saldırı planı:
ScummVM Yükleme sayfaları için bir şablon oluşturarak başlamayı öneririm. Bu şablon, bağlantı noktası bakımı yapanlardan/geliştiricilerinden istediğim bilgileri almamın en kolay yolu olacaktır (özellikle bu bilgilerin yetersiz olduğu ya da mevcut olmadığı durumlarda). Mevcut dokümanlardan edindiğim tüm bilgileri önceden dolduracağım. Bu bilgiler daha sonra eksiklik, doğruluk ve güncellik açısından kontrol edilebilir veya gerektiğinde eklenebilir.
Ardından, README, wiki ve web sitesi gibi mevcut dokümanları inceleyeceğim. Bu süreçte, her bölümü gerektiği gibi yeniden yazıp ekleyip tüm bilgileri yeni portala aktaracağım. Ayrıca, portal yayınlandıktan sonra yinelenen, çelişen veya başka anormallikler olmaması için hangi bilgilerin nereden alındığını not edeceğim.
Bu süreçte, eksik bilgileri almak için mentor'lar, geliştiriciler, bağlantıyı koruyanlar ve diğer konu uzmanlarıyla iletişime geçecek, ayrıca her sayfanın mümkün olduğunca güncel ve kapsamlı olmasını sağlayacağım.
İş birliği amacıyla ve danışmanların onayıyla, devam eden çalışma portalını yazma süreci boyunca ScummVM topluluğunun erişimine sunmak, anlık geri bildirimler almak ve süreç boyunca hiçbir şeyin gözden kaçmadığından emin olmak istiyorum.
Bu çalışmada ve ileriye dönük 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.
Anlaşılırlığı artırmak için mümkün olduğunda ekran görüntüleri, GIF'ler ve diğer görsel yardımcıları kullanacağım.
Önerilen zaman çizelgesi:
Toplulukla bağ kurma 17 Ağustos - 13 Eylül 2020
Projenin vizyonunda ince ayar yapmak ve doküman yapısı ve içeriği gibi ayrıntıları kesinleştirmek için mentorlarla ve daha geniş ScummVM topluluğuyla görüşmeye devam edin.
1. Hafta 14 - 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 ilgili taşıma işlemini sürdüren/geliştiren kişilere dağıtın.
2. Hafta 21 Eylül - 27 Eylül
- Yeni doküman portalını ayarlayın.
3. Hafta 28 Eylül - 4 Ekim
ScummVM'yi kullanma: - Arayüz - Genel ayarlar ScummVM'yi yükleme: - Platforma özgü yükleme kılavuzları, tamamlanmış şablonlar olarak bana döndürülür.
4. Hafta 5 Ekim - 11 Ekim
ScummVM'i kullanma: - Oyun ayarları - Klavye kısayolları ScummVM'i yükleme: - Tamamlanmış şablonlar olarak bana iade edilen platforma özel kurulum kılavuzları
5. Hafta 12-18 Ekim
Gelişmiş seçenekler: - Bulut ve LAN - Eşlemeyi Kontrol Etme ScummVM'yi Yükleme: - Tamamlanan şablonlar bana geri gönderilirken platforma özel yükleme kılavuzları
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: - Tamamlanmış şablonlar olarak platforma özel yükleme kılavuzları bana iade edilir.
8. Hafta 2 Kasım - 8 Kasım
Yardım: - SSS - Kişiler - Bilinen sorunlar
ScummVM'i yükleme: - Tamamlanmış şablonlar olarak platforma özel kurulum kılavuzları bana iade edilir
9. Hafta 9 Kasım - 15 Kasım
Yardım: - Hata bildirme - Oyun notları - Sürüm notları
ScummVM'i 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 kenar çubuğu gezinme, tema/CSS düzenlemeleri gibi portalla ilgili kararların sonlandırılması.
- Tüm bağlantıların beklendiği gibi çalıştığından emin olun.
- Resimlerin/gif'lerin doğru şekilde gösterilip gösterilmediğini kontrol edin.
11. Hafta 23 Kasım - 30 Kasım
- Tamamlanmamış öğeleri tamamlayın ve portalı resmen kullanıma sunun.
- Portal kullanıma sunulduktan sonra, mentorlarla görüşerek diğer kaynaklardaki gereksiz bilgileri kaldırın.