Автогенерация недостающих страниц документации

Рейтинг: 35.4775  
На голосовании
Предложил Семочкин Михаил 26.03.2013 13:01:08

Автогенерация недостающих страниц документации

Предлагаю на основе модуля  Живое описание АПИ сделать автоматический (или хотя бы автоматизированный) апдейт документации.

Я понимаю, что "человеческие" (написанные человеком) описания функций/событий появляются не быстро, но можно было бы хотя бы создать о них заметки.
Преимущества:
- их уже можно будет начинать комментировать, а комментарии бывают ценнее, чем даже  "человеческое" описание.
- по ним будет работать централизованный поиск.
- по ним будет работать внешний поиск (Яндекс/Гугл), в котором зачастую легче найти информацию, чем в штатном поиске.

Если бы попутно отмечалось бы с какой по какую версию существует та или иная функция/событие, то было бы еще лучше.

Рейтинг: 6.7429  
Долганин Антон 26.03.2013 15:29:06
Это было бы здорово, Михаил. Но есть одно НО - это не официальная документация, и компания не имеет права ее публиковать. Другое дело, с лейблом "может быть изменено без предупреждений", но тут опять "но", вы бы использовали API с такой страшной пометкой?

В общем, палка о двух концах. Но так-то я "за".
Рейтинг: 0.638  
Семочкин Михаил 26.03.2013 15:47:58
вы бы использовали API с такой страшной пометкой
А какая тут принципиальная разница от того, увижу ли эту запись в админке (после установки вышеупомянутого модуля) или в общей документации?
Мне так же страшно использовать API, которое я вижу только в админке.

Насчет лейбла - пусть будет лейбл, чтобы понятно было, почему страница такая бедная по содержимому.

Насчет "не официальная документация" - так этим модулем рекомендует пользоваться официальная техподдержка. Что, собственно, меня и побудило написать эту идею.