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:
- HPX
- Teknik yazar:
- rstobaugh
- Proje adı:
- Mevcut HPX Dokümanlarını Düzenleme ve Basitleştirme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Benim önerim, mevcut HPX belgelerinin içeriğini düzenlemek ve sadeleştirmektir. STE||AR grubunun kılavuzunun iki bölümünü (1) "HPX Derleme Sistemi ve Başlatma" ve (2) "HPX Uygulamalarını Yapılandırma"yı gözden geçirmeye odaklanan standart bir dönem (üç ay) projesi öneriyorum.
"HPX Derleme Sistemi ve Başlatma" başlıklı bölümde birkaç dil bilgisi hatası var. Ayrıca, kafa karıştırıcı bir dil ve"CMake" gibi terimlerin tutarsız büyük harf kullanımı mevcut. Ayrıca, gerektiğinde yeniden düzenlemeyi, birleştirmeyi ve kısaltmayı planladığım tekrarlanan bilgiler de var. "HPX Uygulamalarını Yapılandırma" başlıklı bölümde de düzeltilmesi gereken birkaç dil bilgisi hatası olsa da bu bölümle ilgili birincil endişem kullanıcı dostu olmasıdır. Bu bölümde ele almayı planladığım üç önemli tasarım sorunu var:
Bazı başlıklar metnin içine gömülmüş olduğundan bölüme göz atmayı zorlaştırıyor. Şu anda kullanıcıların her tablonun amacını anlamak için kılavuzu dikkatlice okuması gerekiyor. Çoğu kullanıcı, özellikle de içeriği daha önce okumuşsa kullanım kılavuzlarıyla bu şekilde etkileşime girmez. Bunun yerine, her tablonun net ve farklı bir başlığa sahip olmasını planlıyorum. Böylece kullanıcı metinde gezinirken başlığı kolayca görebilir.
Belirli bir başlık altında listelenen çeşitli mülkler mantıklı bir düzene uymuyor. Tesisler ortak bir tema altında gruplandırılmış olsa da alt gruplandırma olmadığından bilgiler dağınık görünüyor. Örneğin, bir kullanıcı yerellikle ilgili birkaç mülk, başka bir konuyla ilgili birkaç mülk ve ardından yerellikle ilgili başka bir mülk görebilir. Başlıklar altında iç yapı olmaması, belirli bir alt konuyla ilgili tüm bilgilerin bulunmasını zorlaştırır. Bu nedenle, benzer bilgileri her bir başlık altında daha net bir şekilde gruplandırmak için bazı grafikleri yeniden düzenlemeyi planlıyorum.
Kullanıcılar, belirli talimatları tam olarak anlamak için bölümler arasında gidip gelmeye (veya kılavuzu iki ayrı sekmede açmaya) zorlanıyor. Kılavuzda, önceki bölümde "bu adım 11. adımdan sonra önceden oluşturuldu" gibi belirsiz bir dil kullanıldığından, bölümün kullanıcıyı yukarı kaydırmaya veya bir köprüyü takip etmeye zorlayarak talimatın tam olarak anlaşılmasını sağlayacak şekilde kullanıcıyı önceki bir bölümdeki tek bir cümleye yönlendirdiği noktalar var. Bu yöntem, tekrarı ortadan kaldırsa da belirli bir sırayla yapılması gereken görevler olduğu için talimatların anlaşılmasını zorlaştırır. Bunun yerine, kullanıcıların bölümler veya dokümanlar arasında geçiş yaparak okuma sürecini kesintiye uğratmaması için daha net bir ifade kullanmanızı öneririm.
Bu bölümleri standart zaman çizelgesi bitmeden önce tamamlayabilirsem STE||AR grubunun Kullanıcı Dokümanları bölümündeki "Neden HPX?" (3) sayfasını da temizlemek isterim. Bu sayfada tekrarlanan bir giriş içeriği var. Bu içeriği birleştirmeyi umuyorum. Ayrıca, büyük harf kullanımı (özellikle jargon) ve üslup açısından tutarsızlıklar var. Bu da sayfaya tutarsız bir hava veriyor. Amacım, STE||AR grubunun çalışmalarını daha birleşik ve tutarlı bir şekilde tanıtmaktır.