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:
- The Julia Language
- Teknik yazar:
- sophb
- Proje adı:
- FluxML web sitesini yeniden tasarlama
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu teklif, Flux'un doküman web sitesini, içerdiği bilgilerin hem yeni başlayanlar hem de uzmanlar için yapılandırılmış ve ilgi çekici olması amacıyla iyileştirmeyi amaçlamaktadır. Daha ayrıntılı olarak belirtmek gerekirse, mevcut dokümanları yeni bölümler halinde yeniden düzenlemek ve yeni başlayanlar için Flux 60-mine-blitz eğitimini genişleten yeni bir başlangıç eğitimi oluşturmak istiyoruz.
Proje aşağıdaki aşamalardan oluşur:
Mevcut doküman web sitesini analiz edin: Mevcut bilgileri denetleyin ve yeni eğitici içerikler oluşturmak için bir stil kılavuzu (bilgiler için) tanımlayın.
Bilgiler ve başlangıç eğitimi için yeni bir yapı tanımlayın: Belgeler web sitesindeki yeni bölümleri ve yeniden düzenlemeyi belirlemek için mentorlarla birlikte çalışın. Ayrıca, başlangıç kılavuzu için bir içindekiler listesi oluşturun. Bunun için Flux 60-mine-blitz eğitim videosunu başlangıç noktası olarak kullanın ve bu videodan yararlanın.
Bilgileri yeniden yapılandırın: Web sitesini, önceki adımda mentorlarla birlikte tanımlanan planla güncelleyin.
Başlangıç eğitimini oluşturun: İlk taslağı yazın ve inceleyin. Mentörlerden geri bildirim alın. Mentörlerle birlikte bu dokümanın nihai bir sürümüne sahip olduğumuzu belirlediğimizde dokümanı doküman web sitesinde yayınlayacağım.
(İsteğe bağlı) Mevcut dokümanları README'ler (README) biçiminde HTML'ye dönüştürün: Dört ana aşamayı tamamladıktan sonra biraz zamanım olursa, web sitesinden daha kolay erişebilmeniz için BENİOKU biçimindeki mevcut eğiticileri 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. Julia'yı yeni kullanmaya başladım ve bunun yeni bir başlangıç eğiticisi için doğru bilgi düzeyini belirlemede çok yararlı olacağına inanıyorum.
Çalışmamın, Flux topluluğunun yeni kullanıcıları bünyesine katmasına yardımcı olmasını sağlamaya odaklanacağım. Ayrıca, deneyimli kullanıcıların yeni kullanım alanları keşfetmesine ve Flux'un ayrıntılarını incelemesine yardımcı olmaya da odaklanacağım.