Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- BRL-CAD
- Teknik yazar:
- sahibkaur
- Proje adı:
- Yeni Başlayanlar iç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 yalnızca BRL-CAD ile yeni tanışan değil aynı zamanda açık kaynak kullanmaya yeni başlayan kullanıcılara da özel dokümanlar oluşturmayı amaçlamaktadır.
Neden bu proje?
BRL-CAD web sitesini ilk ziyaret ettiğimde, açık kaynak ve BRL-CAD konusunda yeni olduğum için bir defada sağlanan bilgi miktarı beni çok şaşırttı. Ama derinden, burada öğrenecek çok şey olduğunu biliyordum. Bu nedenle, benim gibi yeni kullanıcıların bu topluluktan daha fazla yararlanmalarını ve kolayca kullanmaya başlamalarını sağlamak için dokümanlar oluşturmak istedim.
Hedefler
Bu proje yeni kullanıcıları hedefleyecek. Bu nedenle, belgelerimin ulaşmayı hedeflediği bazı noktalar şunlardır: Yeni kullanıcıların kendilerini rahat hissetmesini sağlamak: Bu doküman hem BRL-CAD hem de açık kaynak konusunda yeni olan yeni kullanıcılar için.
Bunun için:
- Belgenin Flesch-Kincaid puanını en az 50'nin üzerinde tuttuğunuzdan emin olun. Flesch-Kincaid yöntemine göre, puan ne kadar yüksek olursa parça o kadar kolay anlaşılır. Okunabilirlik puanını internetten kontrol edebilirsiniz.
- Okuyucuların uzun paragraflar nedeniyle sıkılmaması veya dikkatlerinin dağılmaması için madde işaretli veya numaralı listeler kullanın.
- Daha uzun cümleleri okuyup anlamak için nispeten 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ı önler, nereye gittiklerini ve ne yaptıklarını bildirir. Bunu başarabilmek için, bu yeni başlayanlar için rehberi düzenli bir biçimde belgelememize yardımcı olabilecek, genel hatlarıyla bir zihin haritası oluşturdum.
Proje Açıklaması
Bu proje, yeni kullanıcıların bu yazılımı kullanmaları için belge yazmaya odaklanmaktadır.
Aşağıda, belgeleri nasıl daha açıklayıcı hale getirmek istediğime dair bir örnek verilmiştir.
Temel Giriş: BRL-CAD (be-are-el-cad olarak telaffuz edilir), yapıcı bir katı geometri (CSG) katı modelleme bilgisayar destekli tasarımdı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. BRL-CAD'in açık kaynak bir yazılım olması, katkı yapmanıza ve BRL-CAD'i eskisinden daha iyi hale getirmenize olanak tanır. 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ına ve 3D uzayı tam olarak tanımlamasına ağırlık verir. Bir nesneyi hem dahili hem harici olarak simüle eder. Yapıcı Katı Geometri (CSG): CSG, karmaşık modellerin basit öğeler arasındaki Boole işlemleri dizisi olarak temsil edilmesini sağlar. Temsilde kullanılan en basit katı nesnelere basit nesneler denir. CSG'yi temel düzeyde anlamak için burayı ziyaret edin.
*Proje fikri açıklamasında belirtildiği gibi: Belgeler; temel kurulumu, becerilerin genel açıklamasını, BRL-CAD’in modelleme ilkelerini, başlıca araçların temel kullanımını, modellemeyi, içe/ihracat, analiz ve oluşturma işlemlerini minimum düzeyde kapsamaktadır.
Dokümantasyondaki her bölümü nasıl ele alacağıma ilişkin kısa girişler hazırlanır.
- Temel Kurulum: BRL-CAD yazılımını yüklemek için gereken ekran görüntüleriyle birlikte adım adım açıklamalı bir eğitim ekleyeceğim. Yeni başlayanlara yönelik eğitim, yeni kullanıcılar için iyi bir başlangıç noktasıdır. Eksik olduğunu düşündüğüm şeylerden bazıları:
- Yeni başlayanlar için hazırlanan bu eğiticinin adımları madde işaretli veya numaralı değildir. Her adımın sonunda ekran görüntüsüyle adım adım açıklamalı bir eğitimin olması, kullanıcının eğiticiye yönelme olasılığını artırır.
- Becerilerin genel bir açıklaması: Bu bölüm, BRL-CAD'in harikaları gösterme gücüne sahip olduğu tüm alanları içerecektir. Diyagrama dayalı bir yaklaşım, bu bölüme dikkat çekmek için daha iyi bir yol olacaktır.
- BRL-CAD'in modelleme ilkeleri: Kullanıcı bu modelleme ilkelerini iyice kavradığında BRL-CAD'yi daha iyi anlayabileceğinden bu bölümde daha fazla açıklama gerekir.
- Başlıca araçların temel kullanımı: Bu kısımda, başlıca araçlara ve bunların temel kullanımlarına ilişkin ayrı eğitimler 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 başka bir biçime dönüştürmektir. Bu bölümde, dışa ve içe aktaran dönüşümleri ele alacağız.
- Oluşturma: Oluşturmayla ilgili temel konuları ve yazılımımızda bunun gerekliliğini ele alacağız. Ayrıca kullanıcılar, resimlerin BRL-CAD cinsinden nasıl oluşturulduğunu da öğrenecektir.
Bunun dışında, aşağıdaki noktalara da odaklanacağız:
- Belgenin başlangıcında, bu yazılımın neyle ilgili olduğu konusunda temel bir fikre sahip olacaksınız.
- Kullanıcıların bu açık kaynak topluluğuyla nasıl bağlantı kurabileceği; BRL-CAD zulip sohbetinin bağlantısı.
- Soyut bir düzeyde, belgelemeyi biraz komik hale getirip yeni kullanıcılardan büyük sözcüklerin 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 gerçekleştirebileceği muhteşem şeylerin ekran görüntülerine sahip olacak.
Aşamalar
Temmuz (Teklif İnceleme Dönemi)
- Mevcut eğitimlere 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ğları)
- Mentorlarla proje hakkında tartışma.
- Proje ayrıntılarının hassaslaştırılması.
- Ara hedeflerde gerekli değişiklikleri yapın (gerekiyorsa).
8 Ağustos - 14 Ağustos
- Docbook XML'yi öğrenin
15 Ağustos - 21 Ağustos
- "BRL-CAD'ye Temel Giriş" belgesi 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.
- Tek tek özellikleri ayrı bir sayfada açıklayın.
28 Ağustos - 3 Eylül
- Özellikler için tek tek 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 bir aracın temel kullanımını belgelemek için fikirlerin listesini çıkarı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 aktarmada dönüşüm gerçekleştirenleri inceleme.
9 - 15 Ekim
- İçe ve dışa aktarma belgeleri hazırlayın.
- Oluşturma işlemine başlayın.
16 - 22 Ekim
- Oluşturma eğiticisini belgeleme.
23 - 29 Ekim
- Tüm belgeleri inceliyorum.
30 Ekim - 5 Kasım
- Doküman XML'i ü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 tartışma ve son değişiklikleri yapma.
12 Kasım - 22 Kasım
- Tartışma ve değişiklik süreci.
- Dokümanlara son bir kez değiniliyor.
Hakkımda
Okulumdan beri edebiyatla ilgileniyorum. Okuldan eve dönüp günüm hakkında her şeyi yazardım. Günüm nasıl iyi veya kötü yapardı? Yaptığım hataları ve bunları nasıl geliştirebileceğimi yazmak için daima istekliydim.
Web tasarımcısı olarak eğitimim sırasında, her gün öğrendiklerimizi yazmamız istendi. Karşılaştığım sorunlardan bazılarını ve çözümlerini belgeleyecektim.
İnsan olarak, başkalarına yardımcı olmak için her zaman elimizden geleni yaparım. Okul ve üniversite günlerinde, bu konuları kendim anladıktan sonra bazı konuları arkadaşlarıma açıklardım. GSoD'de yer almak, bir yazar olarak bu açık kaynak topluluğunun dünyanın her yerindeki yeni kullanıcılar için daha ilgi çekici ve yararlı bir hale gelmesine katkıda bulunmak için harika bir adım.