Ürün belgeleri
Uygulamanızın desteklediği görevleri tamamlamaları için kullanıcılara yardımcı olun
Kullanıcılara, uygulamanın işleyişini açıklayan ve görevlerini tamamlamalarına yardımcı olan pratik kılavuzlar sunun.
Ürün özelliklerini pratik talimatlara dönüştürün
- Kılavuz teleskopu hazırlayın
Belge bölümlerini ve hedef kitlelerini inceleyin.
- İçerik sorularını yanıtla
Bir kılavuzun açıklaması gereken iş akışlarını ve bilgileri netleştirin.
- Kamu hizmetini takip edin
Yapı ilerlemesini ve dokümantasyon sitesinin adresini kontrol edin.
Uygulamanın nasıl kullanılacağını açıklayın.
Belgeler, bir ürün sunumunu pratik talimatlarla tamamlar. Hızlı başlangıç ile başlayın, ardından kullanıcıları uygulamanın gerçekte desteklediği iş akışları boyunca yönlendirin.
Belgeleme yapılandırması, bölüm tanımlarını ve soruları kullanıma sunar. Kullanıcının dilinde bir görevi açıklayan bağlam sağlayın.
Kılavuzu çalışan uygulama ile bağlı tutun
İlk faydalı işlemi destekleyin. Başlangıç kılavuzu, yeni kullanıcılara ürün hakkında kısa bir tanıtım sunar. Nereden başlanacağını, hangi bilgilerin gerektiğini ve görevin tamamlandığını gösteren sonucun ne olduğunu açıklamalıdır.
Tekrarlayan bir iş akışını açıklayın.. Gerçek uygulama etiketlerini ve eylemlerini izleyen ayrıntılı bir kılavuz bulunmaktadır. Ön koşullar, numaralandırılmış adımlar ve beklenen sonuç, bir kullanıcının bir iş görevini ekranın genel bir açıklamasını yorumlamadan tekrar etmesine yardımcı olur.
Kapsamlı bir soruya cevap ver. Bazı sorular bir ekran yerine hesaplar, maliyetler veya yayınlarla ilgilidir. SSS, kısa ve öz bir cevap sunar ve ilgili kılavuzlara bağlantılar sağlar, böylece prosedür sitede tekrar tekrar yer almak yerine tek bir yerde tutulur.
Rehberleri ürünle bağlantılı tutun
Anlamlı bir uygulama değişikliğinden sonra belgeleri gözden geçirin. Bir kılavuz, kullanıcıların gerçekte görebileceği etiketleri ve davranışları kullanmalıdır.
Belgeler kendi genel hizmetinde çalışır. Web sitesinden bağlantı verin ve projenizin yayınladığı dillerdeki kılavuzları kontrol edin.
Bir kullanıcının bir sonraki görevi tamamlamasına yardımcı olun
Pratik bir kılavuz nereden başlanacağını, hangi bilgilerin gerektiğini ve sonucun nasıl kontrol edileceğini açıklar. Değeri, okuyucunun uygulamada harekete geçmesine yardımcı olmasından gelir.
Görev birden fazla alana yayıldığında yolculuğa ilgili kılavuzlarla devam edin. Talimatların bir değişiklikten sonra da faydalı kalması için bir ekran değiştiğinde dokümantasyonu inceleyin.
Onaylanan işlevsellikten kullanışlı yardıma
Hazırlık kılavuzu. Belgelerin bölümlerini ve açıklamaları gereken görevleri inceleyin. Hedeflenen kullanıcı ve uygulama davranışını açık tutun.
Eksik bağlamı girin. Ön koşullar, kurallar ve sonuçlar hakkında soruları yanıtlayın. Yazıda, uydurulmuş kontroller yerine gerçek arayüz kullanılmalıdır.
Yayınlandıktan sonra inceleyin ve değiştirin. Uygulamadaki bir rehberi takip edin, dillerini ve ilgili bağlantıları kontrol edin, ardından temel görev değiştiğinde tekrar ziyaret edin.
Ürünü ilk kullanımdan sonra daha kolay kullanın.
Sonuca ulaşılmasına yol gösteren ve uygulamanın ne yaptığına dair genel bir açıklama içeren talimatlar sağlayın.
Ürün belgeleriyle ilgili sorular
Bir özellik sayfası, potansiyel müşterinin yetenekleri ve bunların değeri hakkında bilgi edinmesine yardımcı olur. Bir kılavuz, kullanıcının gerçek kontroller, ön koşullar ve sonuçlar ile birlikte görevi gerçekleştirmesine yardımcı olur. Birbirlerini tamamlar.
Belgeleme araçları, bölüm tanımlarını ve soruları kullanıma sunar. Uygulamanın desteklediği görevleri gözden geçirin, eksik bağlamı sağlayın ve yazım sürecini takip edin.
Proje, kapsamı için yayınlanan yerelleştirilmiş kılavuzları yayınlar. Her yayınlanan dili, eksiksiz prosedürü ve doğru arayüz etiketlerini koruyacak şekilde inceleyin.
Görev, denetimleri veya beklenen sonuç üzerinde bir değişiklik yapıldıktan sonra metni, çalışan uygulamayla karşılaştırarak kontrol edin; orijinal talimatların geçerliliğini varsaymayın.
Bir uç nokta başvurusu, aktif ve çalışan bir API'ye sahip bir projeye aittir. Canlı operasyonlarını ve gerçek başvurusunu kullanın; planlanan rotalar, kullanılabilir bir entegrasyonun belgelenmesi için yeterli değildir.