FINoM
30.09.2014, 17:33
Всем привет!
Хочу пересмотреть подход подачи документации для своего фреймворка, но не совсем понимаю, какой подход лучше выбрать.
Например, официальная документация к jQuery (http://api.jquery.com/) мне кажется неудобной. Чтоб получить желаемое, нужно переклацать много ссылок. Другое дело - альтернативная документация (http://jqapi.com/) там есть удобный поиск, на странице ничего лишнего.
Я больше склоняюяь к варианту, похожему на документацию к Backbone (http://backbonejs.org/) - там все классы и методы описаны в одном файле, справа - относительно удобная менюшка с якорями. Описания очень краткие, что мне и подходит.
В общем, прошу набросать ссылки на разные доки, которые вы считаете удобными.
Хочу пересмотреть подход подачи документации для своего фреймворка, но не совсем понимаю, какой подход лучше выбрать.
Например, официальная документация к jQuery (http://api.jquery.com/) мне кажется неудобной. Чтоб получить желаемое, нужно переклацать много ссылок. Другое дело - альтернативная документация (http://jqapi.com/) там есть удобный поиск, на странице ничего лишнего.
Я больше склоняюяь к варианту, похожему на документацию к Backbone (http://backbonejs.org/) - там все классы и методы описаны в одном файле, справа - относительно удобная менюшка с якорями. Описания очень краткие, что мне и подходит.
В общем, прошу набросать ссылки на разные доки, которые вы считаете удобными.