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:
- Open Collective
- Teknik yazar:
- Anna e só
- Projenin adı:
- Genel yardım dokümanlarını iyileştirme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
İlk izlenimler Medyaları (videolar, GIF'ler, resimler) desteklemeden talimatlar içeren doküman sayfalarıyla karşılaşılırken aynı bölümdeki diğer bölümlerde daha eksiksiz girişler bulunur. Örneğin, Edit Collective yalnızca talimatlardan oluşur, Mali Barındırıcı Ekle seçeneği ise destekleyici medya içerir.
Göz attığım sayfalarda, hiçbir medya alternatif metin özelliği kullanılarak açıklanmıyor. Resim açıklamalarının olmaması, ekran okuyucu kullananların ve medyanın yüklenemediği internet bağlantısı yavaş olan kişilerin dokümanları tam olarak anlamasını engeller.
Dokümanların bazı bölümlerinde sık sorulan sorular ve kullanıcı arayüzünde gezinmeyle ilgili doğrudan talimatlar (ör. Mali Ana Makineyi Değiştirme) birleştirilir. Belgeler arayüzünde içindekiler bölümü olmadığından, kayıt kayıtlarındaki bir değişikliğin sonuçlarından haberdar olan ve yalnızca tarafsız talimatlar isteyen bir kullanıcı, dokümanları ayrıntılı ve fazla titiz olarak algılayabilir.
Teknik belgelerin dili oldukça tutarlı olsa da herkesin kullanımına açık Stil Kılavuzu'nda dokümanların nasıl yazılması gerektiğiyle ilgili çok az bilgi yer almaktadır. Katkıda bulunanlar sayfasında teknik dokümanlara yapılan katkılardan bahsedildiğinden hem Open Collective hem de potansiyel katkıda bulunanlar daha kapsamlı yönergelerden yararlanabilir.
Teklif Kullanıcıların yardım sayfalarını, sunumlarını ve mevcut yapılarını yeniden gözden geçirerek incelemesini öneriyorum.
Metodoloji ve takvim Çeşitli sürelere sahip sürekli geri bildirim döngülerini teşvik eden toplulukla birlikte çalışarak Open Collective dokümanlarını iyileştirmek istiyorum.
Topluluk bağ kurma dönemi (1 Ağustos - 1 Eylül 2019): Open Collective topluluğunu tanıyın! Belirgin ve yeni projelere başlayan etkin üyelerle görüşmeler yapmak, onlara belgelerin mevcut durumuyla ilgili sorular sormak (Rapor 1). Sorguları ve sorunları izlemek için kullanılan tüm dahili sistemleri ve bunları Open Collective Docs'ta belgeleme sürecini not edin (Rapor 2). Belgelerin mevcut sürümündeki gizli sorunların değerlendirilmesi ve bunları çözmek için planın hazırlanması (3. Rapor).
2-6 Eylül: Topluluk bağ kurma döneminde topluluğun yaptığı tüm yorumlar ve öneriler dikkate alınarak ilk geri bildirim ve düzenleme döngüsü. Planımız hazır mı? Bu konuda değişmesi gereken bir şey var mı? (4. Rapor)
9-20 Eylül: Dokümanların daha az kullanılan bölümü ile kavram kanıtlama geliştirme. Herkese açık bir Stil Kılavuzu taslağı (Rapor 5).
23-25 Eylül: Kavram kanıtlama programının değerlendirmeye gönderilmesi (kapalı grup).
26-27 Eylül: Yayın süreci başlamadan önce, konsept kanıtımızda herhangi bir düzenleme yapılması gerekiyor mu? Daha fazla zamana ihtiyacımız var mı? Duruma göre ayarlamalar yapın. (6. Rapor)
30 Eylül - 9 Ekim: Kavram kanıtlama yayınlandı. İkinci geri bildirim döngüsü (herkese açık grup).
10-15 Ekim: Kavramın son kanıtı, değerlendirme ve ayarlama döngüsü. (7. Rapor)
16-20 Ekim: Etkinliklere kısa bir ara [1].
21 Ekim - 23 Kasım: Herkese Açık Stil Kılavuzu nihaidir (8. Rapor). Stil Kılavuzu'nda yer alan tüm talimatların tüm kullanıcı dokümanları sayfalarına uygulanması (Rapor 9). Gerçekleştirilen tüm etkinlikleri ve topluluğa yönelik ek önerileri değerlendiren rapor (Rapor 10).
Talep edilmesi halinde proje süresi uzatılabilir.
[1]: Seyahat planım Dokümanlar Sezonu başvurumdan önceydi.
Çıktılar - Gerçekleştirilen faaliyetlerle ilgili on herkese açık rapor - Hem Open Collective hem de dışarıdan katkıda bulunanların kullanabileceği herkese açık bir stil kılavuzu - Yenilenmiş kullanıcı dokümantasyonu sayfaları