Yazılım , bilgisayarın görevler gerçekleştirmesine veya bilgisayarla etkileşime girmesine izin veren bilgisayar sistemi için geliştirilen rutinleri ve programları ifade eder. Yazılım, üretici tarafından bir sistem bileşeni olarak sağlanabilir veya üretici veya üçüncü taraflarca ayrı uygulamalar olarak oluşturulabilir. Belgeleme , bir ürünün tanımı ve nasıl kullanılacağıdır. Yazılım dokümantasyonu, yazılım uygulamalarını ve bunların nasıl kullanılacağını açıklar.
Bazen yazılım kılavuzları olarak da adlandırılan basılı yazılım belgeleri, genellikle bir kitap gibi, başlık sayfası, içindekiler tablosu, gövde ve dizin içeren bir kitap gibi düzenlenir ve genellikle bazı tipik bileşenlere sahiptir. Çoğu kullanıcının ihtiyaç duyduğu ilk bileşen bir kurulum rehberidir ve gerektiğinde yazılımın çalıştığı çeşitli işletim sistemleri için ayrı kılavuzlar verilir. Kurulum kılavuzu, bilgisayar işletim sistemleri, RAM, sabit disk alanı, Internet bağlantısı ve çevre birimleri gibi diğer gereksinimler veya eklentiler dahil olmak üzere yazılımı çalıştırmak için gereken özellikleri listeler. Bunu, örneğin CD-ROM, DVD veya indirme gibi bir kurulum için adım adım yönergeler izler. Yükleyicinin olağandışı özellikleri ve alternatif konumlar veya düzenli kurulumlar gibi özel yükleme seçeneklerinin açıklaması genel olarak açıklanmaktadır.
“Hızlı başlangıç” kılavuzu genellikle kullanılan basılı yazılım belgelerinin bir sonraki kısmıdır. Kurulum kılavuzunun kalktığı yerden çıkan Hızlı Başlangıç kılavuzu, kullanıcının yazılıma ve temel işlemlere başlamasına yardımcı olur. Bu bölüm, özel yazılıma uygun olarak çeşitli şekillerde düzenlenebilir. Görev odaklı uygulamalar için popüler yöntemlerden biri, bazı mini dersleri tamamlarken kullanıcının yazılımın temel işlevselliğini öğrendiği proje tabanlı bir tanıtımdır.
Basılı yazılım dokümantasyonunda bulmayı bekleyen diğer unsurlar arasında, en son sürümde yeni olan özellikler üzerinde durularak, özelliklerin tamamen tükenmesi; önceki sürümlerden bu yana yapılan ve muhtemelen düzeltilen hataları da içeren bir güncelleme listesi; teknik destek alma konusunda bilgi; hata mesajlarının açıklamaları; ve ileri düzey veya "güç" kullanıcıları için bilgiler. Oyunlar ve diğer yazılım uygulamaları belgelerinde hile sayfaları veya püf noktaları içerebilir.
Basılı yazılım dokümantasyonu tek tür değildir. Her şeyden önce, basılı belgeler çevrimiçi olarak veya pdf olarak da bulunabilir. Ek belgeler ayrıca uygulamanın kendisinde bulunan araç ipuçları ve yardım ekranları, SSS - cevaplar, aranabilir makaleler, web eğitimi, videolar ve diğer biçimlerle birlikte sıkça sorulan soruların listesi şeklinde de bulunabilir.
Yazılım dokümantasyonu kalite bakımından oldukça değişkendir ve bu özellikle yazılım kılavuzları için geçerlidir. İyi olanlar mükemmel olabilir, iyi yönetilmeyenler ise kullanıcıları birçok soruya bırakabilir. Yazılım üreticisinin forumlarında soru sormadan önce belgeleri aramaya zahmet etmeyecek kullanıcılar da var.
