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:
- Julia Dili
- Teknik yazar:
- sofb
- Projenin adı:
- FluxML Web Sitesini Yeniden Keşfetme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu teklif, Flux'un dokümantasyon web sitesini daha iyi hale getirmeyi hedefler. Bu sayede içerdiği bilgiler hem yapılandırılmış hem de yeni başlayanlar ile uzmanlar için ilgi çekici olur. Daha net bir ifadeyle, mevcut belgeleri yeni bölümler halinde yeniden düzenlemenin yanı sıra Flux 60 madeni işiyle ilgili eğiticinin kapsamını genişleten, yeni kullanıcılara yönelik yeni bir başlangıç eğitimi hazırlamayı amaçlıyoruz.
Proje aşağıdaki aşamalardan oluşuyor:
Mevcut doküman web sitesini analiz edin: Mevcut bilgileri denetleyin ve yeni eğiticiler oluşturmak için (bilgi edinmek amacıyla) bir stil kılavuzu tanımlayın.
Bilgi ve başlangıç eğitimi için yeni bir yapı tanımlayın: Yeni bölümleri belirlemek ve dokümantasyon web sitesinin yeniden düzenlenmesi için mentorlarla birlikte çalışın. Ayrıca, başlangıç noktası olarak Flux 60 madenciliği öğreticisini kullanıp bunu temel alarak başlangıç eğitimi için bir içindekiler tablosu tanımlayın.
Bilgileri yeniden yapılandırın: Bir önceki adımda mentorlarla birlikte çalışarak belirlenen planı ekleyerek web sitesini güncelleyin.
Başlangıç eğitimini oluşturun: İlk taslağı yazın ve inceleyin. Danışmanlardan geri bildirim alın. Mentorlar ve ben bu belgenin son bir sürümüne sahip olduğumuza karar verdiğimizde, bu belgeyi belgeleme web sitesinde yayınlayacağım.
(İsteğe bağlı) Mevcut dokümanları README'ler biçiminde HTML'ye dönüştürün: Dört ana aşamayı tamamladıktan sonra biraz zamanım kalırsa README olan mevcut eğiticileri web sitesinden daha kolay erişilebilecek şekilde dönüştürebilirim.
Projenin hedefine ulaşmak amacıyla mevcut belgeleri anlamak ve en iyi yaklaşımı belirlemek için Flux topluluğuyla çok yakın bir şekilde çalışacağım. Ben Julia ile çalışmaya yeni başladım ve bunun yeni başlangıç eğitimiyle ilgili doğru bilgi düzeyini belirlemede çok yararlı olacağına inanıyorum.
Yaptığım çalışmaların, Flux topluluğunun yeni kullanıcılar için ilk katılım sağlamasına yardımcı olmasını sağlamaya odaklanacağım. Ayrıca deneyimli kullanıcıların yeni kullanım alanlarını keşfetmelerine ve Flux'un ince ayrıntılarını keşfetmelerine yardımcı olmaya odaklanacağım.