Vaka analizi oluşturma

Mevcut aşama:
Dokümanlar Sezonu 2021, 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.

Dokümanlar'ın 2021 Sezonu kapsamında kuruluşların son bir değerlendirme ve örnek olay göndermeleri gerekir. Kendi projenizin örnek olayını oluşturmak için kılavuz olarak örnek olay şablonumuzu ve örnek örnek olayımızı kullanın.

Son değerlendirme formu, en az bir ay önce 30 Kasım 2021 saat 18:00'de (UTC) kullanıma sunulacaktır.

Vaka analizine genel bakış

Vaka analizi şablonu aşağıdaki bölümleri içerir:

  • Sorun ifadesi: Yeni veya iyileştirilmiş belgelerle hangi sorunu çözmeye çalışıyordunuz?
  • Teklif özeti: orijinal kuruluş teklifinin kısa bir özeti
  • Proje açıklaması: Projenizin anlatıma dayalı bir açıklaması. Dahil edin:
    • Teklifinizi nasıl oluşturduğunuz (ve orijinal proje fikirleri sayfasına bağlantı).
    • Teknik bir yazarı veya diğer katılımcıları nasıl işe aldığınız ve seçtiğiniz.
    • Projede çalışan kişiler (katılımcılar tarafından istenirse kullanıcı adlarını kullanın).
    • Projenin tamamlanmasının ne kadar sürdüğü (tamamlandıysa).
    • Neleri beğendiniz?
    • Beklenmedik olan neydi? Hangi engellerle veya aksiliklerle karşılaştınız?
    • Hangi dokümanlar oluşturuldu, güncellendi, iyileştirildi veya kaldırıldı?
  • Bu proje, kuruluşunuzda yeni veya güncellenmiş süreç ya da prosedürlerle sonuçlandı mı?
  • Metrikler:
    • Projenin başarısını ölçmek için hangi metrikler seçildi?
    • Bu metrikleri toplayabildiniz mi?
    • Beklediğiniz davranışlarla veya karşılaştırmalarla ilişkilendirildiler mi?
    • Seçtiğiniz metrikler değişti mi? Herhangi bir metriği kaldırdınız veya eklediniz mi?
    • Metriklerinize göre projeniz başarılı oldu mu? (Bunu söylemek için çok erken olabilir.)
    • İleride ne sıklıkta metrik toplamayı planlıyorsunuz?
  • Özet:
    • 2-4 paragrafta proje deneyiminizi özetleyin. Ne öğrendiniz? Gelecekte neyi farklı yapardınız? Benzer bir sorunu belgelemeyle çözmeye çalışan projelere ne tavsiye edersiniz?

Örnek olay kılavuzu

  • Proje güncellemelerinin haftalık günlüğünü tutmak, örnek olayınızı oluşturmanıza yardımcı olacaktır. Her hafta için projenin ilerlemesini (alınacak istekler, sorunlar veya görüşmeler için bağlantılar dahil olmak üzere), nelerin iyi (ya da kötü) gittiğini, öğrendiklerinizi ve sorulan soruları kaydedin.
  • Örnek olayınızı yazarken nazik davranın. Suçlamayın ve yapıcı olun. Örnek olayların herkese açık olduğunu unutmayın.
  • Vaka analizinizde bir blog yayını veya eğitim için kullandığınız üslubu kullanın; aşırı resmi olmayın.