Hatırla Anımsa
Parametrelerden hata kodlarına kadar ezberlenemeyen bilgi parçalarını hatırlayın.
Dokümantasyonu yıllar süren kullanımdan sonra bile canlı tutan şeylerden biri başvuru kaynağı olarak taşıdığı değerdir. Parametrelerden hata kodlarına ve kabul edilebilir değerlere kadar ezberleyemediğimiz bilgi parçalarını hatırlamak, geri çağırmak, bulmak veya aramak için kılavuzların sayfalarını tararız.
Hatırlamayı destekleyen dokümantasyon örnekleri Dockerfile başvuru kaynağı ve GitLab CI/CD YAML söz dizimi başvuru kaynağıdır. Kullanıcının çeşitli teknik “büyüleri” yapabilmek için hatırlaması gereken ayrıntılar hakkında kolayca aranabilen, son derece yapılandırılmış bilgiler sunarlar.
Başvuru dokümantasyonu, ürünün uzun vadeli kullanılabilirliğinin temelidir. Diğer eylemleri karşılamak için oluşturulan dokümanlar bir kez okunup özümsenebilir; başvuru materyalleri ise kullanıcılar uzmanlıklarını derinleştirip gittikçe daha karmaşık uygulamalara yöneldikçe sürekli değerini korur.
Kullanıcının yapmak istediği
Başvuru kaynağı olması dokümantasyonu yıllar sonra bile canlı tutar. Kullanıcılar ezberleyemedikleri bilgileri hatırlamak, geri çağırmak, bulmak veya aramak için kılavuzları tarar.
Dokümanlarınızın bu ihtiyacı karşılamadığını gösteren işaretler
- Kullanıcılar bir parametreyi veya hata kodunu arıyor ve hiçbir şey bulamıyor.
- Başvuru bilgileri blog yazılarına ve sohbet kayıtlarına dağılmış durumda.
- Ürünün söz dizimi veya ayarları için aranabilir, yapılandırılmış bir başvuru kaynağı yok.
Gerçek dünyadan iki örnek
Yaygın içerik türleri
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <reference>, <refsyn>, <properties> | Başvuru | Başvuru, Sözlük |
Bir metrik
başvuru isabet oranı · Doğru sayfayı getiren başvuru aramalarının payı.