Автогенерация недостающих страниц документации
Предлагаю на основе модуля сделать автоматический (или хотя бы автоматизированный) апдейт документации.
Я понимаю, что "человеческие" (написанные человеком) описания функций/событий появляются не быстро, но можно было бы хотя бы создать о них заметки.
Преимущества:
- их уже можно будет начинать комментировать, а комментарии бывают ценнее, чем даже "человеческое" описание.
- по ним будет работать централизованный поиск.
- по ним будет работать внешний поиск (Яндекс/Гугл), в котором зачастую легче найти информацию, чем в штатном поиске.
Если бы попутно отмечалось бы с какой по какую версию существует та или иная функция/событие, то было бы еще лучше.
Я понимаю, что "человеческие" (написанные человеком) описания функций/событий появляются не быстро, но можно было бы хотя бы создать о них заметки.
Преимущества:
- их уже можно будет начинать комментировать, а комментарии бывают ценнее, чем даже "человеческое" описание.
- по ним будет работать централизованный поиск.
- по ним будет работать внешний поиск (Яндекс/Гугл), в котором зачастую легче найти информацию, чем в штатном поиске.
Если бы попутно отмечалось бы с какой по какую версию существует та или иная функция/событие, то было бы еще лучше.
© 2001-2022 «Битрикс», «1С-Битрикс». Работает на 1С-Битрикс: Управление сайтом.
Соглашение об использовании сайта
Соглашение об использовании сайта
В общем, палка о двух концах. Но так-то я "за".
Мне так же страшно использовать API, которое я вижу только в админке.
Насчет лейбла - пусть будет лейбл, чтобы понятно было, почему страница такая бедная по содержимому.
Насчет "не официальная документация" - так этим модулем рекомендует пользоваться официальная техподдержка. Что, собственно, меня и побудило написать эту идею.