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:
- Open Collective
- Teknik yazar:
- Anna e só
- Projenin adı:
- Genel yardım dokümanlarını iyileştirme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
İlk izlenimler Aynı bölümün diğer bölümlerinde daha kapsamlı girişler bulunurken, destekleyici medya (videolar, GIF'ler, resimler) içermeyen talimatlar içeren doküman sayfalarına rastlamak yaygın bir durumdur. Örneğin, Kolektifi Düzenle yalnızca talimatlardan oluşurken Finansal Barındırıcı Ekle destekleyici medya içerir.
Göz attığımız sayfalarda, alternatif metin özelliği kullanılarak hiçbir medya açıklanmıyor. Resim açıklamalarının olmaması, ekran okuyucu kullananlar ve medya öğelerinin yüklenemediği daha yavaş internet bağlantılarına sahip kullanıcılar için dokümanların tam olarak anlaşılmasını engeller.
Belgelerin bazı bölümlerinde SSS ve kullanıcı arayüzünde gezinmeyle ilgili doğrudan talimatlar (ör. Finansal Barındırıcıyı Değiştirme) birleştiriliyor. Doküman arayüzünde içindekiler listesi olmadığından, kayıt kayıtlarındaki bir değişikliğin sonuçlarından haberdar olan ve yalnızca objektif talimatlar isteyen bir kullanıcı, dokümanları ayrıntılı ve çok alakasız olarak algılayabilir.
Teknik dokümanların dili oldukça tutarlı olsa da herkese açık Stil Kılavuzu belgelerinde dokümanların nasıl yazılması gerektiği konusunda fazla az bilgi yer almaktadır. Katkı sayfasında teknik dokümanlara katkılardan bahsedildiğinden hem Open Collective hem de potansiyel katkıda bulunanlar daha kapsamlı yönergelerden yararlanabilir.
Teklif Sunumlarını ve mevcut yapılarını yeniden gözden geçirerek kullanıcılara yardım sayfalarını gözden geçirmeyi öneriyorum.
Metodoloji ve zaman çizelgesi Toplulukla birlikte çalışarak Open Collective dokümanlarını, farklı sürelerde sürekli geri bildirim döngülerini teşvik edecek şekilde iyileştirmek istiyorum.
Toplulukla kaynaşma dönemi (1 Ağustos - 1 Eylül 2019): Open Collective topluluğuyla tanışın. Etkin ve yeni başlayan projelerdeki aktif üyelerle görüşerek dokümanların mevcut durumu hakkında soru sorma (Rapor #1). Sorguları ve sorunları izlemek için kullanılan tüm dahili sistemleri ve bunları Open Collective Dokümanlar'da (Rapor 2) belgeleme sürecini not edin. Dokümanların mevcut sürümündeki gizli sorunların değerlendirilmesi ve bunların çözümüne yönelik bir planın hazırlanması (Rapor #3).
2-6 Eylül: İlk geri bildirim ve düzenleme döngüsünde topluluk tarafından bağ kurma döneminde topluluk tarafından yapılan tüm yorumlar ve öneriler dikkate alınır. Planımız uygun mu? Bu konuda değiştirilmesi gereken bir şey var mı? (Rapor #4)
9-20 Eylül: Dokümanların daha az doldurulmuş bölümüyle kavram kanıtı geliştirildi. Herkese açık bir stil kılavuzu taslağı (Rapor #5).
23-25 Eylül: Kavram kanıtının değerlendirme için gönderilmesi (kapalı grup).
26-27 Eylül: Konsept kanıtımızın yayınlanmadan önce herhangi bir düzenlemeye ihtiyacı var mı? Daha fazla zamana ihtiyacımız var mı? Buna göre ayarlama yapın. (Rapor #6)
30 Eylül - 9 Ekim: Kavram kanıtı kullanıma sunuluyor. İkinci geri bildirim döngüsü (herkese açık grup).
10-15 Ekim: Son kavram kanıtı değerlendirmesi ve ayarlama döngüsü. (Rapor #7)
16-20 Ekim: Etkinliklere kısa bir ara verin [1].
21 Ekim - 23 Kasım: Kamuya açık stil kılavuzu nihai hâle getirildi (Rapor #8). Stil Kılavuzu'ndaki tüm talimatların tüm kullanıcı dokümanı sayfalarına uygulanması (Rapor #9). Gerçekleştirilen tüm etkinlikleri değerlendirip topluluğa yönelik diğer önerileri değerlendirin (Rapor 10).
Proje süresi, istek üzerine uzatılabilir.
[1]: Belge Sezonu başvurumdan önce planlanan gezi.
Teslim edilecekler - Yapılan etkinliklerle ilgili on adet herkese açık rapor - Hem Open Collective'in hem de dışarıdan katkıda bulunanların kullanabileceği herkese açık bir stil kılavuzu - Yenilenen kullanıcı doküman sayfaları