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:
- CERN-HSF
- Teknik yazar:
- LuckInTheRain
- Projenin adı:
- Kök Belgeleri: Analiz, Yeniden Yapılandırma ve Yeniden Yazma
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
Proje dört aşamadan oluşur:
1.) Mevcut ROOT belgelerini analiz etme
ROOT belgesinin tamamı (web sitesi, kullanıcı kılavuzu, C++ referansı, eğiticiler vb.) şu kriterlere göre analiz edilip kontrol edilir: yapılandırma, modülerleştirme, standartlaştırma, erişim mekanizmaları, tutarlılık, kullanılan bilgi türleri, hedef gruba özel hazırlık ve anlaşılırlık. Amaç, bilgi yönetimine ilişkin bir kavram ve yapılandırma için bir matris ile içeriğin standartlaştırılmasına ilişkin bir kılavuz oluşturmaktır.
2.) ROOT ekibiyle birlikte yazılım belgelerini yazmak için bir yöntem belirleme
ROOT ekibine, yazılım belgelerine ilişkin bir OASIS standardı (https://www.oasis-open.org/committees/dita/) olan DITA (Darwin Bilgi Yazma Mimarisi) sunulur. Başlıca odak noktası yazılıma özel içeriğin nasıl yapılandırılacağını ve “kavram”, “görev” ve “referans” olarak temel bilgi türlerinin yazılım belgelerini yazmak için nasıl kullanıldığını anlamaktır.
3.) ROOT belgelerinin yeniden yapılandırılması ve düzenlenmesi
İlk iki adımın sonuçlarına göre ROOT dokümanları hedef gruplara, rollere ve kullanım alanlarına göre yeniden yapılandırılıp modüler hale getirilir. İçerikler ise ilgili öğelere (web sitesi, kullanıcı kılavuzu, C++ referansı, eğiticiler vb.) ve içerik türlerine atanır. Mevcut bilgiler çok kapsamlı olduğundan tutarlı bir referans yapısı da oluşturulmalıdır. Amacımız, kapsamlı bir genel bakış sunmak ve kullanıcılara ihtiyaçları için ROOT'u nasıl kullanabileceklerini net şekilde göstermektir. Buna ek olarak, fiziğe yönelik olmayan kompakt bir giriş bölümü mevcuttur.
4.) ROOT belgelerini yeniden yazma
Özellikle Kullanıcı Rehberi olmak üzere dokümanların ana kısımları DITA yaklaşımına uygun olarak yeniden yazılmıştır. Yapılandırma ve yazma kuralları, gelecekteki dokümanlarda tutarlılık sağlamak için bir Stil Kılavuzu'na kaydedilir. Amaç, ROOT ekibinin ROOT belgelerini gelecekte genişletmesini ve sürdürmesini sağlamaktır.
Tahmini zaman planlaması (5 ay):
1. Aşama: Mevcut ROOT belgelerini analiz edin: 3 hafta.
2. Aşama: ROOT ekibiyle birlikte yazılım belgelerini yazmak için bir yöntem belirleme: 2 hafta.
3. Aşama: ROOT belgelerinin yeniden yapılandırılması ve düzenlenmesi: 4 hafta.
4. Aşama: ROOT belgelerini yeniden yazma: 11 hafta.