«help-documentation» etiketlenmiş sorular

RFC 2606 standardı , dokümantasyonda örnek olarak kullanılması amacıyla example.org , example.net ve example.com alan adlarını saklar . Örnek olarak kullanılabilecek bir telefon numarası (ülke kodu dahil) için bir eşdeğer nedir, örneğin, kullanıcılara telefon numaralarını girmek için hangi formatta bir örnek vermek? En iyi durumda, örnek bir telefon numarası olmak …

112 documentation  standards  help-documentation 

Kapalı . Bu sorunun daha fazla odaklanması gerekiyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu, yalnızca bu yazıyı düzenleyerek tek bir soruna odaklanacak şekilde güncelleyin . Geçen sene kapalı . Kodumu belgelemek istiyorum, aylar sonra tekrar kodu okumak ve taramak için minimum gereksinim olacak. Farklı …

22 documentation  code-reviews  documentation-generation  help-documentation 

Şu anda basit bir metin işaretlemesinde dokümantasyon oluşturmamızı sağlayan AsciiDoc adlı bir sistem kullanıyoruz . Bundan çoklu çıktı formatları üretebiliriz. Sadece pdf çıktı ve chm çıktı formatlarını kullanıyoruz. Chm'e bir alternatif olup olmadığını merak ediyordum? Aradığım şey, yazılımımızla çevrimdışı kullanılabilen bir şeydir (bu çok önemlidir, çünkü kullanıcılarımızın çok azı çok …

12 documentation  html  help-documentation