Başarılı Belgeleme Projeleri Bölüm 3/3 Yazma

Böylece kullanıcı dokümantasyon projenizi anlıyorsunuz ve bunu belirlediniz. Artık yazmaya hazırsınız. İşte size yolda yardımcı olacak bazı ipuçları. Bu makale yazının kendisiyle ilgili değil; yazı ile birlikte gelen şeyler hakkındadır. (Çevrimiçi yardım yazma hakkında bilgi için bkz. Www.divinewrite.com/helpfulhelp.htm.)

NOT: Bu, iyi bir kullanıcı dokümantasyon sürecinin temel unsurlarını özetleyen üç serinin son makalesidir. (Bu serideki birinci ve ikinci makaleleri okumak için http://www.divinewrite.com/docoprocess1.htm ve http://www.divinewrite.com/docoprocess2.htm adresine gidin.)

Endeksleme

Dizin anahtar sözcükleri konu yazılırken tanımlanmalıdır. Şu anda, konu yazarların zihninde net ve tüm karmaşık ayrıntılara çok aşinadırlar. Yazma aşamasında indeksleme aynı zamanda anahtar kelimelerinizin taslak sürecin bir parçası olarak gözden geçirilmesi anlamına gelir.
Bazı geliştirme araçları, bu tür bir yaklaşımı gerçekten pek kolaylaştırmaz (örneğin, bazıları indeksleme için gereken dosyalara birden çok yazar erişimine izin vermez), ancak en azından anahtar sözcükler her taslağın sonunda listelenmelidir. (Yazım aracına bağlı olarak, bu aslında gözden geçirenler için daha kolay olabilir.) İPUCU: İndeksleme hakkında daha fazla bilgi için, Bonura’nın The Art of Indexing (1994) yazısına bakın.

Kullanıcı belgeleri incelemeleri

Kullanıcı belgelerinizin teknik olarak doğru ve okunabilir olduğundan emin olmak için, akıllı bir insan grubu tarafından gözden geçirilmesini sağlamanız gerekir. Bir yazılım projesi için, gözden geçirme listeniz bir konu uzmanı (genellikle programcı), yazılım mimarı, belki proje yöneticisi ve başka bir yazarı içermelidir. Gözden geçirme gereksinimleri her taslakta değişiklik göstereceğinden, incelemecileriniz ve inceleme prosedürleriniz çalışma uygulamalarınızda belgelenmelidir.

Kullanıcı belgelerinizi test etme

Test birkaç seviyede gerçekleştirilebilir:

Her yazar, ürünü kullanmak için kendi kullanıcı belgelerini takip ederek test etmelidir. Ancak unutmayın, bu tür bir test çok güçlü değildir, çünkü yazarların talimatları gerçekte yazdıkları gibi değil, yazdıklarını düşündükleri gibi takip etme eğilimi vardır.
İkinci seviye, testin akran değerlendirmesinin bir parçası olarak diğer yazarlar tarafından gerçekleştirilmesi içindir.
Üçüncü düzey, test departmanının kullanıcı belgeleri üzerinde resmi testler yapması içindir. Bu tür testler genellikle olmaz, ancak bunu gerçekleştirmeye çalışmak iyidir.
Dördüncü seviye, Beta testinin bir parçası olarak yürütülür / yapılmalıdır (bkz. Dokümantasyon Projelerinizi Yönetme, Hackos (1994), s. 452-453).

Hangi düzeyde test kullanırsanız kullanın, belgelenen görevlerin ürün için doğru olduğundan ve herhangi bir çevrimiçi yardımın doğru çalıştığından emin olmak için tasarlanmalıdır. Kullanıcı belgelerinin testi geçmesi için, projenin önceki aşamalarında belirlediğiniz hedefleri karşılaması gerekir.

Kullanıcı belgelerinizi yerelleştirme

Yerelleştirme genellikle bir yazı sonrası etkinlik olarak kabul edilse de, en iyisi bunu yazma aşamasının bir parçası olarak yapmaktır. Kesin zamanlama projeden projeye değişebilir, ancak iyi bir pratik kural, çevirmenlerin ikinci taslaklar üzerinde çalışmasını sağlamaktır (ancak yalnızca taslakta çok fazla değişiklik beklemiyorsanız). İPUCU: Çoğu çevirmen, kendilerine öğün olarak gönderilen konular yerine büyük bir kullanıcı dokümantasyonu üzerinde çalışmayı tercih edecektir, bu nedenle saygın boyutta bir şeyin, belki de bütün bir konu alanına gönderilmesini beklemelisiniz. tek bir konunun aksine.

Yerelleştirme ile bir dengeleme eylemi gerçekleştiriyorsunuz. Kullanıcı belgelerini çevirmenlere çok erken gönderirseniz, çevirilerde değişiklik yapmak için çok para harcarsınız. Çok geç gönderirseniz, ürünün piyasaya sürülmesi için zamanında hazır olmayacaktır.

Değişikliği yönetmek

Ürün ve / veya geliştirme programındaki değişikliklerin etkisini en aza indirmeniz önemlidir. Bunu yapmak için, aşağıdakileri yapan bir teknik geliştirmeniz gerekir:

1. Değişikliği tanımlar
2. Zaman ve / veya kaynaklardaki etkiyi tahmin eder *
3. Proje yöneticisini bilgilendirir

* Projede daha önce kullandığınız aynı tahmin tekniklerini kullanabilirsiniz.

Yazma ilerlemesini izleme

Yazma aşamasının sadece yazmakla ilgili olmadığına dikkat etmek önemlidir. İlerlemenizi yol boyunca her adımda takip ederseniz, kilometre taşlarınızı ve son tarihlerinizi karşılayıp karşılamayacağınızı görebileceksiniz ve ayrıca bu projeyi bir sonraki aşamayı daha iyi planlamak için bir öğrenme deneyimi olarak kullanabileceksiniz. (Devam eden bakım ve gelecekteki proje referansı için tüm proje kayıtlarının kolayca erişilebilir olmasını sağlamalısınız.)

Bu prosedürde özetlenen her adımı gerçekleştirmek için harcanan zamanı ve ayrıca her taslak aşama, inceleme süreleri, toplam geri dönüş süreleri vb. Takip etmelisiniz.

Düzenli ekip toplantıları yapmak

Tüm ekip üyelerini yazma ilerlemesinden haberdar etmek için düzenli ekip toplantıları yapmalısınız. Bu toplantılar, izleme ölçütlerinize göz atmak ve şu anda devam etmekte olan çeşitli konular için tahmini tamamlanma yüzdesini tartışmak için bir forum olmalıdır. Tahmini tamamlanma yüzdesi, halihazırda harcanan sürenin verilmesi gerekenden daha düşükse, o zaman buna göre hareket edebilirsiniz. Bu toplantılar, yazma sürecindeki aksaklıkları belirlemenizi sağlar.

İlerleme raporları yazmak

Yönetiminizin de projenin durumu hakkında bilgilendirilmesi gerekir. Aşağıdakileri özetleyen periyodik ilerleme raporları yazmalısınız:

Proje nerede
Geçen ay ne yaptın
Önümüzdeki ay ne yapmayı planlıyorsun
Karşılaştığınız sorunlar

Üretimi Yönet

Yapımın anlamı, ne tür belgeler üzerinde çalıştığınıza ve izleyicinin kim olduğuna bağlı olarak değişir. Aşağıdakiler gibi şeyleri kapsayabilir:

Baskı
Bağlayıcı
Ürün oluşturma (yardım ürüne derlendiğinde)

Üretim aşaması genellikle yalnızca yönetim gerektirse de, üretim ekibiyle prova yapmak ve bağlantı kurmak için biraz zaman harcamanız gerekir.

Projeyi Değerlendirin

Değerlendirme aşamasının amacı şunları dikkate almaktır:

Proje plana göre mi gitti?
Neden? / Neden olmasın?
Bireysel ekip üyeleri genel projeye nasıl katkıda bulundu.
Proje yöneticisinin performansı.
Belgelerin hedeflerine ulaşıp ulaşmadığı.

İzleme ölçümleriniz bu aşamada kullanışlı olacaktır; proje ilerlemesinde herhangi bir kusur varsa, bunları tespit etmek için bir yol kat etmeleri gerekir. Ayrıca Hackos’un Dokümantasyon Projelerinizi Yönetmek için Hackos (1994), s.514-518 tarafından sağlanan örnek değerlendirme raporunu da kullanabilirsiniz.

Belgeleriniz başarılı mı?

Artık belgeleri yazıp yayınladığınıza göre, hedeflerinize ulaşıp ulaşmadığını belirlemeniz gerekir. Bunu doğru bir şekilde yapmanın tek yolu, daha fazla kullanıcı araştırması yapmaktır.

İPUCU: Araştırma yöntemleriyle ilgili ayrıntılar için Hackos (1994) tarafından Dokümantasyon Projelerinizi Yönetme, Hackos & Redish’in Arayüz Tasarımı için Kullanıcı ve Görev Analizi (1998), Sosyal Pazarlama: Manoff’tan Halk Sağlığı için Yeni Zorunluluk (1985) bölümlerine bakın. , Designing Qualitative Research 2nd Edition by Marshall & Rossman (1995) ve Conducting Focus Groups A Guide for First-Time Users, Marketing Intelligence and Planning by Tynan & Drayton (1988).

Ve bu kadar! Unutmayın, bu süreç ideal bir süreçtir. Size ve projenize uyan parçaları alın ve uymayan parçaları bırakın.

İyi şanslar!