TheGoodDokümanlarProject projesi

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:
TheGoodDocsProject
Teknik yazar:
Çokluk
Projenin adı:
Bilgi mimarisi rehberi
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

Bilgi Mimarisi Rehber Planı

Bu belgede, Good Docs Projesi için bilgi mimarisi rehberinin planlanması ele alınmaktadır. Bu belge, Google Dokümanlar 2020 Sezonu gönderiminin bir parçası olarak hazırlandı. Önerilen kılavuzun kullanım alanı özetlenir ve planlama amacıyla bu tür bir kılavuzun yapısının bir planı hazırlanır.

Bilgi mimarisi (IA), içeriğin nasıl düzenlendiğiyle ilgilidir. İçeriğin kendisinde kullanılan stili veya kelimeleri tanımlamadan içerik yapısını kapsar. Örneğin, bir IA planı okuyucunun kim olduğunu, içeriğe nasıl yaklaştığını ve okuduğu ortamı göz önünde bulundurur. Ardından, okuyucuların gereksinimlerini en iyi şekilde karşılayacak bir içerik yapısını belirler.

Kusursuz bir dünyada belgeleme, belgelemenin amaçlarını tanımlamak için işletme hedeflerini kullanan bir içerik stratejisiyle başlayarak tasarlanır. Ardından içerik stratejisi, belgenin düzenini ve yapısını tanımlayan bir IA oluşturmak için kullanılır. Bu noktadan sonra araç zincirleri seçilebilir ve içerik yazılabilir. Çoğu açık kaynak projesinin gerçekliği şudur: İçerik stratejisi "insanların bu projenin nasıl kullanılacağını bilebilmesi için belgeler yazmak" kadar basittir, ancak bu basit strateji bile etkili bir IA belirlemek için yeterlidir.

Bu kılavuzun amacı, profesyonel olmayan yazarların hangi şablonları kullanmaları gerektiğini belirlemek için yeterli olan bir IA geliştirmeleri için basitleştirilmiş bir araç sağlamaktır. Öğleden sonra sıradan bir insan tarafından tamamlayılabilecek kadar basit olmalı ve eğitim yerine eyleme öncelik vermelidir. İdeal olarak, kavramları kısa ve öz bir şekilde anlatır, okuyucuyu bu kavramları kendi projeleriyle ilişkili olarak düşünmeye yönlendirir ve sonucu olarak bir sonraki kavrama geçer.

Bu projenin temeli olarak, okuyucuların Good Docs Project’e nasıl başlayacaklarını anlayabilmesi ve şablon seçimlerine yön vermek için IA kılavuzunu etkili bir şekilde kullanabilmeleri için README projesinde bazı güncellemeler yapılması gerekmektedir.

Birincil kitle

Projeleri için belge oluşturmak üzere Good Docs Project şablonlarını kullanmak isteyen tüm kullanıcılar

Kullanım örnekleri: Bu bölüm, okuyucuların IA Kılavuzu'na nasıl yaklaştığını incelemek için tasarlanmıştır. Bu, söz konusu okuyuculara en iyi şekilde hizmet vermek için kılavuzun nasıl yapılandırılması gerektiğini belirlememize yardımcı olabilir.

Senaryo: Bir kişi, çok az belgesi olan veya hiç olmayan açık kaynaklı bir projede ya da kötü düzenlenmiş veya kötü düzenlenmiş bir belge paketi üzerinde çalışıyor. Belgelerini düzenlemek için İyi Dokümanlar Projesi’ni kullanmaya karar veriyorlar ama nereden başlayacaklarından emin değiller. Şablonları kullanmaya nasıl başlayacaklarını anlamak için README bölümünü, içerik stratejisini geliştirmek ve doküman paketlerinin nasıl görüneceğini planlamak için Information Architecture Guide'ı takip ederler.

Teklif

README’yi güncelleyerek yeni okuyucuya ilk adımları net bir şekilde göstererek proje boyunca daha net bir şekilde rehberlik etmesini sağlayın. Bu ilk adımlardan biri, yeni bir IA Kılavuzu'ndaki soruları okuyup yanıtlamak olacaktır. Bu kılavuzda kitle, içerik şeması, kullanıcı/görev matrisleri gibi unsurlar dikkate almaya davet edilir ve akademik bağlamda bu konuları öğrenmek/anlamak için okuyucuya fazla yük yüklenmez. Bu görev tamamlandıktan sonra, okuyucu hangi şablonların gerekli olduğunu ve bunları en iyi şekilde nasıl tamamlayacağını anlamış olur.

Araştırma

Bunu araştırmalarla destekleyebilmek için Abby Covert'ın kitabına (http://www.howtomakesenseofanymess.com/) yoğun bir şekilde odaklanacağım. Çünkü kısmen bu kitapla ilgili bilgi sahibiydim ve kitap, önceden yazdığım ve kullanacağım pek çok içeriğin temelini oluşturdu. Ayrıca, IA'ya yeni katılanlar için çok kolay bir şekilde ilgilenip okuyacakları da oldu. Bu anlamda, bir IA ağ geçidi ilacı.

Taslak Hizmet Şartları

BENİOKU:

-- İyi Dokümanlar Projesi'ne Giriş |_ Şablonları kimler kullanmalıdır? |_ Şablonların işleyiş şekli |_ Projeye katkı -- Şablonlar |_ Tüm mevcut şablonların listesi |_ Kullanılacak şablonları seçme |_ Başlamadan önce -- Yazmaya başlamadan önce |_ Belgeleri kim okuyor? |_ Dokümanları neden okuyorlar? |_ Okuyucularınız için yazılar

IA Kılavuzu:

-- Giriş |_ IA nedir? |_ Neden önemsemeliyim? -- Karışıklığı belirleyin -- Niyetinizi belirtin -- Yüz gerçekliği -- Yön seçin -- Mesafeyi ölçün -- Yapıyla oynayın -- Ayarlamaya hazır olun