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:
- BRL-CAD
- Teknik yazar:
- sahibkaur
- Projenin adı:
- Yeni Başlayanlar İçin BRL-CAD Kılavuzu
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Yeni Başlayanlar İçin BRL-CAD Kılavuzu
Proje Özeti
Bu proje sadece BRL-CAD ile yeni tanışan değil, açık kaynak konusunda da yeni olan kullanıcılara özel dokümanlar oluşturmayı amaçlamaktadır.
Neden bu proje?
Açık kaynak ve BRL-CAD konusunda yeni olduğumden BRL-CAD web sitesini ilk ziyaret ettiğimde bir anda bu kadar fazla bilgi aldım. Ancak derinlerinde öğrenecek çok şey olduğunu biliyordum. Bu nedenle, benim gibi yeni kullanıcıların bu topluluktan daha fazla yararlanmalarını sağlamak ve çalışmaya başlarken kendilerini rahat hissetmelerini sağlamak için dokümanlar oluşturmak istedim.
Goller
Bu proje yeni kullanıcıları hedefleyecek. Belgelerimin ulaşmayı hedeflediği bazı noktalar şunlardır: Yeni kullanıcıların kendilerini rahat hissetmesini sağlamak için: Bu dokümanlar hem BRL-CAD ile yeni tanışan kullanıcılar için hem de açık kaynak konusunda yeni olan kullanıcılar için geçerlidir.
Bunun için:
- Belgenin Flesch-Kincaid puanını en az 50'nin üzerinde tutun. Flesch-Kincaid yöntemine göre, puan ne kadar yüksek olursa, parçanın anlaşılması da o kadar kolay olur. Okunabilirlik puanını internet üzerinden kontrol edebilirsiniz.
- Okuyucuların uzun paragraflar nedeniyle sıkılmaması veya dikkatlerini dağıtmaması için madde işaretli veya numaralı listeler kullanın.
- Uzun cümleleri okuyup anlamak için daha fazla zihinsel çalışma gerektiğinden, daha kısa paragraflar ve cümleler kullanın.
- Metni bölmek için alt başlıklar kullanın. İyi yapılandırılmış belgeler: İyi yapılandırılmış belgeler, yeni kullanıcıları yönlendirmede çok önemli bir rol oynar. Kaybolmalarını engeller ve nereye gittiklerini ve ne yaptıklarını bildirir. Bunu başarmak için, bu başlangıç kılavuzunu düzenli bir şekilde belgelememize yardımcı olabilecek kaba bir zihin haritası oluşturdum.
Proje Açıklaması
Bu proje yeni kullanıcıların bu yazılımı kullanmalarını sağlayacak dokümanlar yazmaya odaklanmaktadır.
Dokümanları nasıl daha açıklayıcı hale getirmek istediğime dair bir örnek aşağıda verilmiştir.
Temel Giriş: BRL-CAD (be-are-el-cad) yapıcı bir katı geometri (CSG) katı modelleme bilgisayar destekli tasarımıdır (CAD). 3D bilgisayar destekli tasarım ve grafik görselleştirme için güçlü, platformlar arası, açık kaynaklı bir katı modelleme sistemidir. Kafanıza hakim olamıyor musunuz? Ayrıntılarıyla inceleyelim. Açık kaynak: Açık kaynak yazılım, herkesin inceleyebileceği, değiştirebileceği ve geliştirebileceği kaynak kodlu bir yazılımdır. Açık kaynak bir yazılım olan BRL-CAD sayesinde, BRL-CAD ile katkıda bulunup bunu her zamankinden daha iyi yapabilirsiniz. Bilgisayar Destekli Tasarım (CAD): Basit bir şekilde ifade etmek gerekirse CAD, fiziksel nesnelerin iki veya üç boyutlu grafik temsilini oluşturmak için bilgisayar programlarının kullanılmasıdır. Katı modelleme sistemi: BRL-CAD, katı modelleme CAD'sine odaklanır. Katı modelleme, diğer geometrik modelleme biçimlerinden ayrılırken, fiziksel olarak doğru olması ve 3D uzayı tam olarak tanımlaması ön plandadır. Bir nesneyi hem içten hem de dıştan simüle eder. Yapıcı Katı Geometri (CSG): CSG, karmaşık modellerin, basit öğeler arasındaki bir dizi Boole işlemi olarak temsil edilmesini sağlar. Temsil için kullanılan en basit katı nesnelere primitif denir. CSG'yi temel düzeyde anlamak için burayı ziyaret edin.
*Proje fikri açıklamasında belirtildiği gibi: Belgeler; temel kurulumu, özelliklerin genel açıklamasını, BRL-CAD'nin modelleme ilkelerini, başlıca araçların temel kullanımını, modelleme, içe/dışa aktarma, analiz ve oluşturma işlemlerini asgari düzeyde kapsamaktadır.
Belgelerin her bir bölümünü nasıl işleyebileceğime dair kısa giriş niteliğindedir.
- Temel Yükleme: Gerekli ekran görüntüleriyle birlikte BRL-CAD yazılımını nasıl yükleyeceğinizi adım adım anlatacağım. Yeni başlayanlar için eğitim, yeni kullanıcılar için güzel bir başlangıç noktasıdır. Eksik olduğunu düşündüğüm şeylerden bazıları:
- Yeni başlayanlar için hazırlanan bu eğitimin adımları madde işaretli veya numaralı değil. Her adımın sonunda bir ekran görüntüsü içeren adım adım anlatıma sahip olmak, kullanıcının eğitime yönelme olasılığını artırır.
- Yeteneklerin genel bir açıklaması: Bu bölüm, BRL-CAD'nin harikaları gösterme gücüne sahip olduğu tüm alanları içerecektir. Diyagrama dayalı bir yaklaşım, dikkatleri bu bölüme yöneltmenin daha iyi bir yolu olacaktır.
- BRL-CAD’in modelleme ilkeleri: Bu bölümde daha fazla açıklama yapılması gerekir. Çünkü kullanıcı, bu modelleme ilkelerini iyice kavradığında BRL-CAD'yi daha iyi anlayabilir.
- Başlıca araçların temel kullanımı: Bu plan kapsamında, başlıca araçlara ve bunların temel kullanımlarına ilişkin ayrı eğiticiler sunacağız. Bunlar adım adım eğitimler olacaktır.
- Dışa/İçe Aktarma: Kullanıcılar, Geometri Dönüşüm Kitaplığı hakkında bilgi sahibi olur. BRL-CAD'nin en yaygın kullanımlarından biri, geometriyi bir biçimden diğerine dönüştürmektir. Bu bölümde, dışa ve içe aktarma dönüşümü gerçekleştirenler ele alınmaktadır.
- Oluşturma: Oluşturmayla ilgili temel bilgileri ve yazılımımızda bunun gerekliliğini ele alacağız. Kullanıcılar ayrıca resimlerin BRL-CAD cinsinden nasıl oluşturulacağını da öğrenecektir.
Bunların dışında, aşağıdaki noktalara da odaklanacağız:
- Belgelemenin başlangıcında, bu yazılımın neyle ilgili olduğu hakkında temel bir fikir edineceksiniz.
- Kullanıcıların bu açık kaynak topluluğuyla nasıl bağlantı kurabileceği; BRL-CAD zulip sohbeti bağlantısı.
- Soyut bir düzeyde, dokümanları biraz mizahi bir yaklaşımla ele alarak yeni kullanıcıların büyük sözlerle cesaretini kırmamalarını rica ediyoruz. BRL-CAD wiki ana sayfasında kullanılan empatiye dayalı yaklaşımı beğendim.
- Kullanıcıların bu yazılımı kullanarak yapabilecekleri bazı harika şeylerin ekran görüntülerine sahip olacak.
Aşamalar
Temmuz (Teklif İnceleme Dönemi)
- Mevcut eğiticilere devam ederken yazılımı ve wiki dokümanlarını daha iyi tanıyacağım.
- Mevcut dokümanlarda iyileştirmeler yapacağım.
1 Ağustos - 7 Ağustos (Topluluk bağı)
- Mentorlarla proje hakkında konuşma.
- Proje ayrıntılarını netleştirmek.
- Ara hedeflerde gerekli değişiklikleri yapın (gerekiyorsa).
8 Ağustos - 14 Ağustos
- Docbook XML'yi tanıyın
15 Ağustos - 21 Ağustos
- "BRL-CAD'e Giriş" belgesini yazma
- "Temel Yükleme" için adım adım eğitim yazma
22 Ağustos - 27 Ağustos
- BRL-CAD'in çeşitli özelliklerini keşfetme ve bunları ekran görüntüleriyle birlikte listeleme.
- Özellikleri ayrı bir sayfada açıklayın.
28 Ağustos - 3 Eylül
- Özellikler için bağımsız dokümanlar üzerinde çalışmaya devam edin.
4 Eylül - 10 Eylül
- Modelleme İlkeleri Üzerinde Çalışma.
- Tüm modelleme ilkelerini açıklama.
11 Eylül - 17 Eylül
- Önemli araçların temel kullanımı üzerinde çalışın.
- Her aracın temel kullanımını belgelemek için fikirlerin kısa bir listesini yapın.
18 Eylül - 24 Eylül
- Her aracın kullanımını belgelemek.
25 Eylül - 1 Ekim
- Eğitim için sağlam bir model oluşturmak ve bununla birlikte bir taslak yazmak için Modelleme üzerinde çalışın.
2 Ekim - 8 Ekim
- Modelleme taslağını iyileştirin.
2 Ekim - 8 Ekim
- Dışa ve içe aktarma dönüşümü gerçekleştirenleri inceleme.
9 - 15 Ekim
- Dışa ve içe aktarmayla ilgili belgeleri hazırlayın.
- Oluşturma işlemine başlayın.
16 - 22 Ekim
- Oluşturma eğiticisini belgeleme.
23 Ekim - 29 Ekim
- Tüm belgeleri inceliyorum.
30 Ekim - 5 Kasım
- Docbook XML'si üzerinde çalışma
6 Kasım - 12 Kasım
- Mentorlardan ve diğer topluluk üyelerinden inceleme yapmalarını isteyin ve değişiklikler üzerinde çalışın.
- Mentorlarla görüşmek ve son değişiklikleri yapmak.
12 Kasım - 22 Kasım
- Tartışma ve değişiklik süreci.
- Dokümanlarla ilgili son dokunuş yapılıyor.
Hakkımda
Okul yıllarından beri yazı yazmaya çalışıyorum. Okuldan eve dönüp günüm hakkında her şeyi yazardım. Günümü nasıl daha iyi veya daha kötü geçiren onu ne olurdu? Yaptığım hataları ve bunları nasıl geliştirebileceğimi yazmak için her zaman istekliydim.
Web tasarımcısı olarak eğitimim sırasında, her gün öğrendiklerimizi yazmamız istendi. Karşılaştığım bazı sorunları ve bunların çözümlerini belgeleyecektim.
Kişi olarak, başkalarına yardımcı olmak için her zaman elimden geleni yaparım. Okul ve üniversite günlerinde, bu konuları kendim anladıktan sonra arkadaşlarıma bazı konuları açıklardım. GSoD'da yer almak, bir yazar olarak bu açık kaynak topluluğunun dünyanın her yerinden yeni kullanıcılar için daha ilgi çekici ve faydalı hale gelmesine katkıda bulunabileceğim harika bir adım.