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:
- BRL-CAD
- Teknik yazar:
- sahibkaur
- Projenin adı:
- Yeni Başlayanlar İçin BRL-CAD Kılavuzu
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
BRL-CAD İçin Yeni Başlayanlar Kılavuzu
Proje Özeti
Bu projenin amacı, hem BRL-CAD hem de açık kaynak konusunda yeni olan kullanıcılara yönelik dokümanlar oluşturmaktır.
Neden bu proje?
Açık kaynak ve BRL-CAD'de yeni olduğum için BRL-CAD web sitesini ilk ziyaret ettiğimde, bir anda karşılaştığım bilgi miktarı beni bunaltmıştı. Ancak içten içe, burada öğrenilecek çok şey olduğunu biliyordum. Bu nedenle, benim gibi yeni kullanıcıların bu topluluktan en iyi şekilde yararlanması ve rahatça başlaması için dokümanlar oluşturmak istedim.
Hedefler
Bu proje yeni kullanıcıları hedefleyecek. Bu nedenle, dokümanlarımın ulaşmaya çalıştığı bazı noktaları aşağıda bulabilirsiniz: Yeni kullanıcıların kendilerini rahat hissetmesini sağlamak: Bu dokümanlar yalnızca BRL-CAD'e yeni başlayanlar için değil, açık kaynak yazılımlara da yeni başlayanlar içindir.
Bunu başarmak için şunları yapacağım:
- 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çanın anlaşılması o kadar kolay olur. Okunabilirlik puanını internetten kontrol edebilirsiniz.
- Okuyucuların uzun paragraflardan sıkılmaması veya dikkatinin dağılmaması için madde işaretli veya numaralı listeler kullanın.
- Daha uzun cümleleri okumak ve anlamak nispeten daha fazla zihinsel çalışma gerektirdiğ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ış dokümanlar: İyi yapılandırılmış dokümanlar, yeni kullanıcılara yol göstermede önemli bir rol oynar. Bu sayede kaybolmazlar, nereye gittiklerini ve ne yaptıklarını bilirler. Bu hedefe ulaşmak için bu başlangıç kılavuzunu düzenli bir şekilde belgelememize yardımcı olabilecek kaba bir beyin haritası oluşturdum.
Proje Açıklaması
Bu proje, yeni kullanıcıların bu yazılımı kullanabilmesi için dokümanlar yazmaya odaklanır.
Aşağıda, dokümanları nasıl daha açıklayıcı hale getirmeyi amaçladığıma dair bir örnek verilmiştir.
Temel Giriş: BRL-CAD (be-are-el-cad olarak okunur), yapısal katı geometri (CSG) katı modelleme bilgisayar destekli tasarım (CAD) yazılımıdır. 3D bilgisayar destekli tasarım ve grafik görselleştirme için güçlü, platformlar arası, açık kaynaklı bir katı modelleme sistemidir. Bu konuyu anlayamıyor musunuz? Ayrıntılarıyla inceleyelim. Açık kaynak: Açık kaynaklı yazılım, herkesin inceleyebileceği, değiştirebileceği ve geliştirebileceği kaynak koduna sahip bir yazılımdır. Açık kaynak bir yazılım olan BRL-CAD'e katkıda bulunarak BRL-CAD'i daha iyi hale getirmenizi bekliyoruz. Bilgisayar Destekli Tasarım (CAD): Basitçe ifade etmek gerekirse CAD, fiziksel nesnelerin iki veya üç boyutlu grafiksel temsilini oluşturmak için bilgisayar programlarının kullanılmasıdır. Katı modelleme sistemi: BRL-CAD, CAD'nin katı modellemeye odaklanır. Katı modelleme, fiziksel olarak doğru olması ve 3D alanı tam olarak tanımlaması sayesinde diğer geometrik modelleme biçimlerinden ayrılır. Bir nesneyi hem dahili hem de harici olarak simüle eder. Yapısal Katı Geometri (CSG): CSG, karmaşık modelleri primitifler arasındaki bir dizi mantıksal işlem olarak temsil etmenize olanak tanır. 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: Belgelerde minimum olarak temel kurulum, yeteneklerin genel açıklaması, BRL-CAD’in modelleme ilkeleri, başlıca araçların temel kullanımı, modelleme, içe/dışa aktarma, analiz ve işleme konuları ele alınacaktır.
Belgedeki her bölümü nasıl ele alacağıma dair kısa tanıtımlar aşağıda verilmiştir.
- Temel Kurulum: Gerekli ekran görüntüleriyle birlikte BRL-CAD yazılımını yüklemeyle ilgili adım adım 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 olan bazı noktalar:
- Bu başlangıç kılavuzunun adımları madde işareti veya numara içermez. Her adımın sonunda ekran görüntüsü içeren adım adım bir eğitim, kullanıcının eğitime ilgi duymasını sağlar.
- Özelliklerin genel açıklaması: Bu bölümde, BRL-CAD'in harikalar gösterme gücüne sahip olduğu tüm alanlar yer alır. Bu bölüme dikkat çekmenin daha iyi bir yolu şematik bir yaklaşımdır.
- BRL-CAD'in modelleme ilkeleri: Bu bölümde daha fazla açıklamaya ihtiyaç duyulur. Çünkü kullanıcı, bu modelleme ilkelerini iyice anladıktan sonra BRL-CAD'i daha iyi anlayabilir.
- Önemli araçların temel kullanımı: Bu bölümde, önemli araçlar ve bunların temel kullanımıyla ilgili ayrı eğitimler yer alacaktır. Bunlar adım adım talimatlar olacaktır.
- Dışa Aktarma/İçe Aktarma: Kullanıcılar, Geometri Dönüşüm Kitaplığı hakkında bilgi edinir. BRL-CAD'in en yaygın kullanımlarından biri, geometriyi bir biçimden diğerine dönüştürmektir. Bu bölümde, dışa aktarma ve içe aktarma dönüştürücüleri ele alınmaktadır.
- Oluşturma: Oluşturmayla ilgili temel bilgileri ve yazılımımızdaki gerekliliğini ele alacağız. Kullanıcılar ayrıca BRL-CAD'de resimlerin nasıl oluşturulacağını da öğrenirler.
Bunun dışında aşağıdaki noktalara da odaklanılır:
- Dokümanların başında bu yazılımın neyle ilgili olduğuyla ilgili temel bilgiler yer alır.
- Kullanıcılar bu açık kaynak topluluğuyla nasıl bağlantı kurabilir? BRL-CAD zulip sohbet bağlantısı.
- Soyut bir seviyede, belgeleri biraz esprili bir şekilde yapmak ve yeni kullanıcılardan büyük sözlerden caydırılmamalarını istemek. BRL-CAD wiki ana sayfasında kullanılan empatik yaklaşımı beğendim.
- Burada, kullanıcıların bu yazılımı kullanarak yapabileceği bazı harika şeylerin ekran görüntüleri yer alır.
Hedefler
Temmuz (Teklif İnceleme Dönemi)
- Mevcut eğitici içerikleri inceleyerek 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 (Toplulukla bağ kurma)
- Proje hakkında mentorlarla görüşme
- Proje ayrıntılarını hassaslaştırma
- (Gerekirse) dönüm noktalarında gerekli değişiklikleri yapın.
8 Ağustos - 14 Ağustos
- Docbook XML ile tanışın
15 - 21 Ağustos
- "BRL-CAD'e Temel Giriş" dokümanı yazma
- "Temel Kurulum" için adım adım açıklamalı eğitim yazma
22 Ağustos - 27 Ağustos
- BRL-CAD'in çeşitli özelliklerini keşfetmek ve ekran görüntüleriyle birlikte bunları listelemek.
- Ayrı bir sayfada her bir özelliği açıklayın.
28 Ağustos - 3 Eylül
- Özellikler için ayrı dokümanlar üzerinde çalışmaya devam edin.
4 Eylül - 10 Eylül
- Modelleme İlkeleri Üzerinde Çalışma.
- Tüm modelleme ilkeleri açıklanır.
11-17 Eylül
- Önemli araçların temel kullanımı üzerinde çalışın.
- Her aracın temel kullanımını belgelemek için fikirleri kısa listeye alın.
18 - 24 Eylül
- Her aracın kullanımını belgeleme.
25 Eylül - 1 Ekim
- Modelleme üzerinde çalışarak eğitim için sağlam bir model oluşturun ve bununla birlikte bir taslak yazın.
2 Ekim - 8 Ekim
- Modelleme taslağını iyileştirin.
2 Ekim - 8 Ekim
- İhracat ve ithalat dönüşümü sağlayanlar hakkında çalışma.
9 Ekim - 15 Ekim
- Dışa aktarma ve içe aktarma dokümanlarını hazırlayın.
- Oluşturma işlemine başlayın.
16 Ekim - 22 Ekim
- Oluşturma eğitimi için doküman oluşturma.
23 Ekim - 29 Ekim
- Tüm dokümanları inceliyoruz.
30 Ekim - 5 Kasım
- Docbook XML ü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.
- Mentörlerle görüşme ve son değişiklikleri yapma.
12 Kasım - 22 Kasım
- Müzakere ve değişiklik süreci.
- Dokümanlara son rötuşu yapma.
Hakkımda
Okul günlerimden bu yana yazı yazarım. Okuldan eve geldiğimde günümle ilgili her şeyi yazardım. Günümü iyi veya kötü yapan şeyleri yazardım. Yaptığım hataları ve bunları nasıl iyileştirebileceğimi her zaman not etmeye çalıştım.
Web tasarımcısı olarak eğitim aldığım sırada, her gün öğrendiklerimizi yazmamız isteniyordu. Karşılaştığım bazı sorunları ve çözümlerini belgeledim.
Diğer insanlara yardımcı olmak için her zaman elimden geleni yaparım. Okul ve üniversite yıllarımda, bazı konuları anladıktan sonra arkadaşlarıma açıklardım. GSoD'ye katılmak, bir yazar olarak bu açık kaynak topluluğunun dünyanın dört bir yanındaki yeni kullanıcılar için daha ilgi çekici ve faydalı hale gelmesine katkıda bulunabileceğim muhteşem bir adım.