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:
- CERN-HSF
- Teknik yazar:
- LuckInTheRain
- Proje adı:
- ROOT Belgeleri: Analiz etme, yeniden yapılandırma ve yeniden yazma
- Proje uzunluğu:
- 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ğitici içerikler vb.) aşağıdaki ölçütlere göre analiz edilir ve 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şılabilirlik. Amaç, bilgi yönetimi için bir kavram, içerikleri yapılandırmak için bir matris ve içeriği standartlaştırmak için bir kılavuz oluşturmaktır.
2.) ROOT ekibiyle birlikte yazılım dokümanları yazmak için bir yöntem tanımlama
ROOT ekibine, yazılım dokümanları için OASIS standardı olan DITA (Darwin Information Typing Architecture) (https://www.oasis-open.org/committees/dita/) sunulur. Ana odak, yazılıma özgü içeriğin nasıl yapılandırılacağını ve yazılım dokümanları yazarken "kavram", "görev" ve "referans" gibi temel bilgi türlerinin nasıl kullanıldığını anlamaya yöneliktir.
3.) ROOT dokümanlarının 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ır ve modülerleştirilir. İçerikler de ilgili öğelere (web sitesi, kullanıcı kılavuzu, C++ referansı, eğitici içerikler vb.) ve içerik türlerine atanır. Mevcut bilgiler çok kapsamlı olduğundan tutarlı bir referans yapısı da oluşturulmalıdır. Amaç, kapsamlı bir genel bakış sunmak ve kullanıcılara ROOT'u ihtiyaçları için nasıl kullanabileceklerini net bir şekilde göstermektir. Ayrıca, fizik odaklı olmayan kompakt bir giriş sağlanır.
4.) ROOT dokümanlarını yeniden yazma
Dokümanların ana bölümleri, özellikle de Kullanıcı Kılavuzu, DITA yaklaşımına uygun şekilde yeniden yazılmıştır. Gelecekteki dokümanlarda tutarlılık sağlamak için yapılandırma ve yazım kuralları bir Stil Kılavuzu'na kaydedilir. Amaç, ROOT ekibinin gelecekte ROOT belgelerini genişletmesini ve saklamasını sağlamaktır.
Tahmini zaman çizelgesi (5 ay):
1. Aşama: Mevcut ROOT belgelerini analiz edin: 3 hafta.
2. Aşama: ROOT ekibiyle birlikte yazılım dokümanları yazmak için bir yöntem tanımlama: 2 hafta.
3. Aşama: ROOT dokümanlarının yeniden yapılandırılması ve düzenlenmesi: 4 hafta.
4. Aşama: ROOT dokümanlarını yeniden yazma: 11 hafta.