Показать сообщение отдельно
  #1 (permalink)  
Старый 30.09.2014, 17:33
Аватар для FINoM
Новичок
Отправить личное сообщение для FINoM Посмотреть профиль Найти все сообщения от FINoM
 
Регистрация: 05.09.2010
Сообщений: 2,298

Лучшая структура документации
Всем привет!
Хочу пересмотреть подход подачи документации для своего фреймворка, но не совсем понимаю, какой подход лучше выбрать.

Например, официальная документация к jQuery мне кажется неудобной. Чтоб получить желаемое, нужно переклацать много ссылок. Другое дело - альтернативная документация там есть удобный поиск, на странице ничего лишнего.

Я больше склоняюяь к варианту, похожему на документацию к Backbone - там все классы и методы описаны в одном файле, справа - относительно удобная менюшка с якорями. Описания очень краткие, что мне и подходит.

В общем, прошу набросать ссылки на разные доки, которые вы считаете удобными.
__________________
"Matreshka is fucking awesome" © чувак с Reddit
Matreshka.js - Три возможности
Ответить с цитированием