Benim web uygulaması için yardım (örneğin bazı düğme ne açıklamalarını göster) yazmak için bir şartı var. Bunu yapmak için herhangi bir iyi örnekler var mı?
Ben çok zarif ve ayrık olmak inşa motor Hudson yardım bulduk.
Sen bir yardım simgesi var, bunu üzerine tıklayın, yardım metni satır içi sayfasını expaned, sen kaybolur tekrar tıklatın.
https://hudson.dev.java.net/hudson.jnlp başlatmayı deneyin ve http://localhost:8080/configure gidin ve pek çok (?) Düğmelerini sağ tarafında tıklayın.
Java Doc java kod dosyası içinde dahil tüm yorumları ayıklamak için kullanılabilir
Ben sadece iyi eski HTML / CSS kullanmak istiyorum - bu davranışı, kullanıcıların zaten bir tarayıcıda bilmek koruyacak ve zaten uygulama için stil sayfasını olmalıdır Eğer küçük bir ek ile yardım sayfalarında L & F korumak olacak yani çaba.
Google Maps'te yardımıyla bir göz atın (http://maps.google.co.uk/support/) - düzeni fikirler, vs
Ben Google yardım sayfalarına baktığında Farkettim Bir şey biraz yanıltıcıdır olabilir arama (hiçbir sürpriz var) oldu - sitenizin bakan dış ise o zaman ben 'site ile bunu uygulamak istiyorum: <{[ (0)]}> 'anahtar kelime ve Google arama kullanın. Siteniz dahili ise kendi arama rulo gerekecek, ama bu çok zor olmamalı ve muhtemelen oldukça eğlenceli bir alt-proje olacaktır.
PHP kullanarak ediyorsanız, phpDocumentor bakabilirsiniz.
The phpDocumentor tool is a standalone auto-documentor similar to JavaDoc written in PHP.
Her düğme ne gösteren bir kullanım kılavuzu üreten arıyorsanız, ben Debugmode Wink veya ekran etkileşimi kayıt ve daha sonra bir Flash film ya da PDF dönüştürme için Adobe Captivate yararlı gibi bir şey kullanarak bulduk.
Specifically for Rails: http://github.com/darthapo/comatose/tree/master is a great little CMS tool that you can use for imbedded help systems.
Aksi takdirde, http://tenderapp.com/ barındırılan bir çözüm olarak güzel çalışıyor.