Mevcut aşama:
2021 Dokümanlar Sezonu programı 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.
Dokümanlar'ın 2021 Sezonu programında kuruluşlar doküman oluşturmak, geliştirmek ve güncellemek için doğrudan teknik yazarlarla birlikte çalışır. Kuruluşlar teknik yazarları doğrudan seçer. Kuruluşlarla çalışmak isteyen teknik yazarlar, kuruluşun teklif sayfasında belirtilen kanalı kullanarak ilgi beyanı göndermelidir.
İlgi beyanınız iletişim bilgilerinizi, teknik yazı deneyiminizle ilgili bilgileri ve kuruluşla yapacağınız çalışmaların bir özetini içermelidir. Ayrıca kuruluşun teknik yazarlar için sahip olduğu belirli koşulları nasıl karşıladığınızı da vurgulamalısınız. Gerekli tüm bilgileri eklediğinizden emin olmak için kurumun proje fikirleri sayfasını dikkatli bir şekilde okuyun.
Bu şablon, kendi menfaatinizi oluşturmanıza yardımcı olacak bir taslak niteliğindedir.
Kişisel bilgiler
- Adınızı ve e-posta adresinizi ekleyin. Adınızın herkese açık nihai örnek olay raporlarında yer almasını istemiyorsanız lütfen bunu teklifinizde belirtin ve bir kullanıcı adı sağlayın.
Mesleki bilgiler
- Yazı örneklerinden oluşan herkesin erişebileceği bir portföye veya çalışmalarınızın örneklerine tek tek bağlantılar getiren bir bağlantı.
- Son teknik yazarlık deneyiminize genel bakış: En son teknik yazarlık pozisyonlarınızı veya iş deneyiminizi listeleyin. Açık kaynak belgeleme deneyiminiz varsa onu da buraya ekleyin. Rolünüzü, üstlendiğiniz pozisyonun sorumluluklarını ve tamamladığınız işi özetleyin. Uygun durumlarda tarihleri belirtin.
- Öz geçmişinize veya müfredat özgeçmişinize yönlendiren bir bağlantı.
- Kurum proje için belirli şartlar belirlediyse bu gereklilikleri nasıl karşıladığınızı açıklayan bir ya da iki cümle ekleyin, örneğin, “Teknik yazar olarak altıdan fazla doküman düzeltmesine katıldım ve 2018, 2019 ve 2020’de XYZ Industries’deki ekibim için üç doküman düzeltmesi yönettim.”
- (İsteğe bağlı) Eklemek istediğiniz diğer bilgiler. Örneğin, teknik dokümanlara olan ilginiz, Dokümanlar Sezonu'na neden katılmak istediğiniz veya ilgili başka bir deneyim.
Proje açıklaması
- Proje başlığı. Kurumun proje sayfasında birkaç olası proje listeleniyorsa menfaat bildirimi unvanınızın, üzerinde çalışmak istediğiniz projeyi yansıttığından emin olun. Henüz olası projeleri belirlememiş bir kuruma menfaat bildirimi gönderiyorsanız unvanınız, önerdiğiniz çalışmayı özetlemelidir. Örneğin, "Create Interactive ProjectX API Documentation", "Documentation for ProjectX" başlığı yerine daha iyi bir başlıktır.
- Ayrıntılı açıklama.
- Projeye nasıl yaklaşacağınızı, kurumun proje teklifi sayfasında belirttiği bir açıklamayı girin.
- Teklif ettiğiniz şeyin sorunu nasıl çözeceğini veya kurumun proje teklifi sayfasında belirlediği hedefi nasıl karşılayacağını söyleyin.
- Kurumun üyeleriyle proje hakkında yaptığınız tüm görüşmelerin bir özetini ekleyin.
- Teklifinizin diline ve stiline dikkat edin. Açık kaynak kuruluşu, teklifinizi değerlendirirken bu bilgileri bir faktör olarak kullanabilir.
- Önerilen zaman çizelgesi
- Projenin zaman çizelgesini ve aşamalarını genel hatlarıyla tarif edin. Örneğin, bilgi toplamak için iki hafta, yazı yazmak için dört hafta, inceleme ve değişiklikler için iki hafta ve yayın için bir hafta ayırabilirsiniz.
- Proje üyelerinin katılım ve geri bildirim verme konusundaki beklentilerini açıkça belirtin. Örneğin, zaman çizelgenizin, sorgulara üç gün içinde yanıt almaya bağlı olduğunu belirtebilirsiniz.
- Önerilen bütçe
- Teknik yazarların saatlik ücret yerine projenin tamamı için bir bütçe önermelerini öneririz.
- Mümkünse kapsamın daraltılması veya genişletilmesi için seçenekler sunun. Örneğin iki, dört veya altı platforma yönelik dağıtım talimatlarını belgelemek için farklı bütçe seçenekleri sunabilirsiniz.