Pratik Yap Alıştırma Yap

Ürünü günlük, standart kullanımda nasıl çalıştıracağınızı öğrenin.

Yedi Eylemli Dokümantasyon ModeliBuradasınız: practice

Kullanıcıların, ilgilendikleri ürün bölümlerinin çoğunu nasıl çalıştıracaklarını öğrenmeleri gerekir. Örneğin yöneticiler kullanıcı oluşturmayı ve silmeyi öğrenmelidir. Pratik Yap eylemi, işlemsel bilgiyi öğrenme ihtiyacını, yani ürünün günlük ve standart kullanımda nasıl çalıştırılacağını açıklar.

Pratiği destekleyen dokümantasyon örnekleri GitHub’da yeni bir SSH anahtarı oluşturma, Mailchimp’e kişi aktarma ve Dynatrace’te kullanıcı yönetimi sayfalarıdır. Görsel-işitsel materyal içeren ya da içermeyen çeşitli nasıl yapılır kılavuzu veya öğretici kalıpları sunarlar; hepsinin ortak amacı kullanıcının bir işlemi ustalıkla yapmasını sağlamaktır.

Kullanıcılar görevleri güvenle yerine getirebildiklerinde gelişmiş özellikleri keşfetmeye ve ürünün savunucusu olmaya daha yatkındır. Bu tür dokümanlar, teorik bilgiyi pratik yetkinliğe dönüştürerek kullanıcı yetkinleştirme programlarının ve sertifikasyon yollarının omurgasını oluşturur.

Kullanıcının yapmak istediği

Kullanıcıların ürünün çoğu bölümünü nasıl çalıştıracaklarını öğrenmeleri gerekir. Pratik, işlemsel bilgi ihtiyacını, yani ürünün günlük ve standart kullanımda nasıl çalıştırılacağını açıklar.

Dokümanlarınızın bu ihtiyacı karşılamadığını gösteren işaretler

  • Aynı nasıl yapılır soruları destek ve topluluk kanallarında tekrar tekrar soruluyor.
  • İşlemler yalnızca sözlü ekip bilgisi olarak veya birinin zihninde var oluyor.
  • Yaygın yönetim görevleri için adım adım kılavuz yok.

Gerçek dünyadan iki örnek

Yaygın içerik türleri

DITADiátaxisGood Docs Project
<task>, <step>, <choicetable>Nasıl yapılır kılavuzuNasıl yapılır kılavuzu

Bir metrik

görev başarısı · Standart bir işlemi destek almadan tamamlayan kullanıcıların payı.