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:
- HPX
- Teknik yazar:
- rstobaugh
- Projenin adı:
- Mevcut HPX Belgelerini Düzenleme ve Kolaylaştırma
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Teklifim, mevcut HPX belgelerinin içeriğini düzenlemek ve basitleştirmek. Teklifim, STE||AR grubu kılavuzunun iki bölümünün revize edilmesine odaklanan standart süreli (üç aylık) bir proje içindir: "HPX Derleme Sistemi ve Lansman" (1) ve "HPX Uygulamalarını Yapılandırma" (2).
"HPX Derleme Sistemi ve Lansman" ile ilgili bölümde birkaç dil bilgisi hatası var, ayrıca kafa karıştırıcı dil ve"CMake" gibi terimlerde tutarsız büyük harf kullanımı içeriyor. Ayrıca, tekrarlayan bilgiler içeriyor. Bunları gerektiği gibi yeniden düzenlemek, birleştirmek ve kırpmak istiyorum. "HPX Uygulamalarını Yapılandırma" ile ilgili bölümde ilgilenilmesi gereken birkaç dil bilgisi hatası da bulunmakla birlikte, bu bölümle ilgili temel endişem kullanım kolaylığı. Bölümde ele almayı planladığım üç temel tasarım sorunu var:
Bazı başlıklar metnin içine gömülüdür, bu da bölüme göz atmayı zorlaştırır. Şu anda, her tablonun amacını anlamak için kullanıcının kılavuzu dikkatli bir şekilde okuması gerekir. Özellikle içeriği daha önce okumuş olan kullanıcıların çoğu kullanım kılavuzlarıyla bu şekilde etkileşim kurmaz. Bunun yerine, her tabloda kullanıcı metni kaydırdığında kolayca görülebilecek net ve ayrı bir başlık olmasını sağlamayı planlıyorum.
Çeşitli tesisleri belirli bir başlık altında listelerken özellikler mantıksal bir sıra izlemez. Özellikler ortak bir tema altında gruplandırılırken, bilgilerin dağılmış gibi görünmesine neden olan alt gruplamalar yoktur. Örneğin, bir kullanıcı konumla ilgili birkaç mülkle, birkaçı başka bir konuyla ilgili, ardından da konumla ilgili başka mülklerle karşılaşabilir. Başlıklar altında dahili yapının olmaması, belirli bir alt konudaki tüm bilgilerin bulunmasını zorlaştırır. Bu nedenle, benzer bilgileri her başlık altında daha net bir şekilde gruplandırmak için grafiklerden bazılarını yeniden düzenlemeyi planlıyorum.
Kullanıcılar, belirli talimatları tam olarak anlamak için bölümler arasında gidip gelmek (veya kılavuzu iki ayrı sekmede açmak) zorlanır. Kılavuzda, önceki bölümde "bu adım 11. adımdan sonra oluşturulmuştur" gibi belirsiz bir dil kullanıldığından bölüm, okuyucuyu yukarı kaydırmaya veya tam talimatı anlamak için bir köprüyü izlemeye zorlayacak şekilde kullanıcıyı önceki bölümdeki tek bir cümleye yönlendirir. Bu yöntem tekrarı ortadan kaldırsa da talimatların belirli bir sırada önceden oluşturulması gereken görevler olduğundan, bunları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 işlemlerini yarıda kesmemesi için daha spesifik ifadeler dahil etmenizi öneriyorum.
Bu bölümleri standart zaman çizelgesi tamamlanmadan önce tamamlarsam, STE||AR grubunun Kullanıcı Belgeleri altındaki “Neden HPX?” (3) sayfasını da temizlemek istiyorum. Bu sayfada, birleştirmeyi umduğum tekrar eden tanıtım içerikleri var. Büyük harf (özellikle jargon) ve üslupta tutarsızlıklara yol açan bu tutarsızlıklar içeriyor. Amacım STE||AR grubunun çalışmasına ilişkin daha bütünsel ve tutarlı bir giriş oluşturmak.