Рейтинг: 5.6706  
Новая
Предложил Компания Scoder 29.03.2019 09:55:35

Отдельное поле для документации (инструкции) к модулям маркетплейс

Для модулей на маркетплейс было бы хорошо заложить отдельное поле "Ссылка на документацию" или что то подобное. Как это есть с демо и также вывести для нее отдельную красивую кнопочку.

Как в примере во вложении:
Файлы:
info.png (374.37 КБ)
Рейтинг: 0.2797  
На голосовании
Предложил Клёпов Роман 18.10.2016 11:40:50

Доработать и написать документацию по CSaleViewedProduct::GetList

Приветствую, коллеги!

Доработайте, пожалуйста API - добавьте более сложную фильтрацию товаров - по стандартным полям инфоблока и свойствам.

Хотелось бы писать функционал опираясь на официальную документацию. Добавьте, пожалуйста ее для этого API.
Рейтинг: 0.0913  
Ответил Жуков Евгений 18.10.2016 12:33:21
Этот метод, как и функционал, базирующийся на нем, является устаревшим. Необходимо использовать \Bitrix\Catalog\CatalogViewedProductTable
Рейтинг: 2.1455  
Отложено
Предложил Smirnov Pavel 23.05.2016 16:30:16

В учебных курсах писать "Нет комментариев", если комментариев к странице 0.

В конце страницы урока, например:

http://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43&LESSON_ID=2803

Есть ссылка "Развернуть комментарии" - которая показывается даже если комментариев нет.
Это запутывает - чтобы узнать, есть ли комментарии, нужно щёлкнуть по этой ссылке.

Нужно добавить однозначное сообщение (например, "Комментариев пока нет") о том, что комментарии отсутствуют. И ссылку для разворачивания комментариев в этом случае не показывать.
Рейтинг: 0  
Ответил Басыров Роберт 02.06.2016 16:42:11
Ну, по-хорошему, информация из комментариев должна постепенно попадать в основную статью.
Так и происходит.
В отличии от документации (АПИ, пользовательской) комментарии в курсах не предназначались изначально для показа их пользователям. С их помощью можно указать нам на ошибки, дать дополнительную информации (опять же нам, сотрудникам документации), запросить какую-то информацию по теме.
Мы работаем с этими комментариями: проверяем их, дополняем в курс, если сочтём нужным.
Наша проблема в том, что мы не всегда оперативно реагируем на них. Особенно это актуально для курса Разработчик Bitrix Framework, где без консультаций разработчиков сложно принять решение по написанному комментарию. А разработчики, как правило, очень заняты.

Число комментариев не будет выводиться, это официальный ответ.
Рейтинг: 8.3975  
Отложено
Предложил Талызенков Сергей 30.04.2016 10:02:50

Позволить пользователям добавлять информацию в документацию

Идея разрешить и поощрять пользователей создавать документацию.
Сейчас, чтобы почитать по d7 нужно читать курсы, потом еще гуглить сайт, форум/блоги.
Из-за этого много информации которую ищешь, просто не читаешь. А это сильно тормозит саморазвитие и увеличение навыков.

Если весь опыт будет в одном месте, уверен это очень сильно всем поможет.

Чтобы пользователи размещали именно в документацию, нужно их стимулировать бонусами.
Размещение информации - премодерируемое.

Создать свод правил по которым нужно размещать документацию.
В документации  создать перелинковку с курсами.  
Рейтинг: 0  
Ответил Басыров Роберт 06.05.2016 18:18:51
Чем для этой цели не устраивают вас комментарии к доке и страницам курса?
Под каждой из страниц есть форма для добавления, даже в новой доке по D7. Пишите, никто же не против.

Бонусы - никогда не были против раздачи баллов по партнёрской программе. Более того, давали и раздавали такие бонусы за реальную помощь.
Деньгами - это уже сложнее. Не уверен, что такая идея получит поддержку у руководства.

Свод правил - не нужен, не нужно вам забивать голову стилями, оформлением и так далее. Просто выдайте то, что считаете нужным. Мы сами и отсеем и оформим.

Если нет страниц, куда надо добавить, просто шлите информацию на мой e-mail и она отобразится в курсах, документации.

Перелинковка доки и курсов - есть, может не везде и не туда, это возможно. Но для этого и создано поле для комментариев. Пишите, добавим линки.

Для донесения полезной информации до нас есть все инструменты. Вопрос в самой информации. Помниться, после того как появилось поле для комментариев, мы создали по просьбам пользователей пустые страницы в доке по неописанным методам, чтобы была возможность добавлять комментарии по этим методам. Помниться даже наполнили с десяток страниц. Но и всё, сейчас дело заглохло.

Идею с голосования снимаю, не надо придумывать какие-то дополнительные механизмы.
Рейтинг: 5.6431  
На голосовании
Предложил Клёпов Роман 24.03.2016 14:51:36

Не хватает документации (класс CUserOptions)

Добрый день, разработчики (и особенно Роберт)!

Не нашел описание класса CUserOptions, разобраться можно только по исходникам. Функционал не так часто встречаемый, тем не менее нужный для разработки собственных продуктов.

Добавьте, поожалуйста!
Рейтинг: 1  
Ответил Басыров Роберт 02.06.2016 16:44:52
С радостью бы. :)
Но устойчивая позиция технического руководства: документацию по АПИ должны писать разработчики. А у них на это не хватает времени.
Как только будет такое описание от разработчика - сразу добавим. Но, думается, лучше смотреть в сторону D7.
Рейтинг: 0.1905  
Новая
Предложил Тисленко Сергей 17.03.2016 13:32:43

Расширение объема курсов и документации.

Было бы неплохо расширить разделы документации и курсов.
Допустим есть функционал, не суть важно насколько он новый, но в документации нет детального описания работы с ним и его настройки, нет подробного описания его возможностей и ограничений.
Пример из свежего..
CRM + 1С: есть только инструкция по подключению и запись в блоге что возможно сделать при данной интеграции, но всё описано довольно поверхностно. Без нюансов и деталей с которыми часто можно столкнуться, и многие, очень многие заваливают вопросами отдел поддержки или пишут вопросы в блог, спрашивают друг друга..  
К сожалению, даже по прошествии многих месяцев нет возможности открыть документацию и прочесть пусть собранную по крупицам но столь полезную информацию. Партнерам приходится вести собственную документацию по продуктам Битрикса, клиентам задавать вопросы направо и налево.. и порой ждать ответа месяцами.
Возможно даже партнерам стоит поделится подобной информацией что бы Битрикс свел это в одно целое. Как думаете?
Рейтинг: 0.0936  
Ответил Басыров Роберт 02.06.2016 16:47:46
Да без проблем. Мы никогда не отказывались от помощи.
Мой адрес - есть на сайте, со мной легко связаться через мессенджер или БитриксНетВорк.
Шлите материалы, всё что будет интересно, будет опубликовано.
Можно ещё проще - через комментарии к курсам или доке.
Рейтинг: 1.3109  
На голосовании
Предложил Клёпов Роман 18.06.2015 17:34:24

Документация по блогу

Добрый вечер, разработчики Битрикс!

Напишите более детальную документацию по модулю Блог и его компонентам, плохо документирован.
Рейтинг: 3.9781  
Новая
Предложил Ерофеев Анатолий 30.04.2015 14:12:12

Правила написания исходного кода на PHP

На официальном сайте 1С-Битрикс уже давно висит заметка о правилах написания исходного кода.
http://dev.1c-bitrix.ru/docs/php_recommendation.php
Будем откровенны - следуют им далеко не все программисты. Не раз видел такой сайт-чудище Франкенштейна - сколько программистов - столько и стилей расставления {}, отступов и наименований.

Как же заставить всех следовать правилам? Мои идеи:
1) Ввести в монитор качества тест, который проверял бы оформление всего php-кода в папках local, bitrix/templates, bitrix/php_interface. Хочешь-не хочешь, а люди начнут вспоминать про существование этих правил.
2) В маркетплейсе ввести аналогичную проверку для загружаемых решений. По результату проверки либо совсем запрещать публикацию модуля, либо как-то визуально выделять в маркетплейсе такие решения. Например, если решение прошло проверку на оформление кода, добавлять бейджик "100% следование стандарту" (метод пряника) или наоборот. (метод кнута).
Рейтинг: 4.9679  
На голосовании
Предложил Шерлок Холмс 05.12.2014 17:42:28

продвижение Битрикс на Европейский рынок

Давайте будем честными, Битрикс не пользуется популярностью на европейском рынке, о таком слове вообще никто не слышал, все знают что такое Друпал, Жумла и Вордпрес, а про Битиркс не слышали.

Хотя по качеству исполнения и по возможностям Битрикс на две головы выше. Хоть в 8-ой версии Друпала и добавили ООП и современные шаблонизаторы, но ядро D7 и ORM все равно оставляют Битиркс лидером по удобству для разработчика, а юзабилити, интерфейс и удобство использования у Битрикса вообще вне конкуренции.

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

Для чего это нужно:
1. платежеспособность европейских клиентов на порядок выше;
2. легко освоить рынок сайтостроения с помощью более качественной CMS;
3. устойчивость и уверенность в завтрашнем дне для программистов и партнеров.

Все знают, что маркетинговый отдел Битрикс творит чудеса, 10% от общего бюджета, который тратит Битрикс, способен легко переплюнуть рекламные активности других CMS. Просто почему-то такая задача не ставится и никаких действий не прозводится.

Что можно сделать:
1. перевести документацию на английский, чтобы привлечь англоязычных разработчиков;
2. перенести часть производства в другие страны (Германия, Польша, Украина);
3. проводить маркетинговую активность на европейском рынке (спонсорство, выставки, реклама);
4. ввести статус "Англоговорящий партнер" для тех кто хочет работать с европейцами и знает английский.

Для примера, сравните документацию для разработчиков на русском языке:
http://dev.1c-bitrix.ru/api_help/
и на английском: http://www.bitrixsoft.com/help/

похоже что на нее (английскую документацию) просто забили, а это как раз одна из основ, почему европейцы боятся осваивать Битрикс, в нем ничего не понятно. Для перевода документации вполне можно привлечь битрикс-сообщество, уверен, у многих хороший технический английский.

Сделать нормальную английскую демо-версию, чтобы любой мог зайти и попробовать ее, а не так как сейчас, заполнить форму, и только тогда может-быть вышлют ссылку на скачивание: http://www.bitrix.de/download/cms/

Часть производства (например, разработку Битрикс24, или разработку управления сайтом) перенести в другие страны, привлечь иностранных разработчиков для работы над системой. Чтобы не было репутации чисто-российской разработки, а была больше ориентированной на запад.

Дублировать перевод блогов от Битрикс на английский (сейчас много полезных нововведений разработчики Битрикс пишут прямо в блогах, какой новый функционал, что он умеет), и все это недоступно англоговорящим разработчикам, если нанять переводчика и просто дублировать текст блогов на английский - было бы намного круче. Сейчас же на английской версии сайта мертвым висят новости за 2011 год на главной странице.

В целом выигрывают космополиты, которые могут охватить весь рынок интернета, а не только узкую его часть. К тому же, качество CMS Битиркс на сегодня намного превышает западные аналоги, нужно только захотеть и сделать, все возможно.

Это в том числе заинтересует новых разработчиков писать под Битрикс, так как они будут видеть перспективы развития и выхода на другие рынки.
Рейтинг: 4.4879  
Новая
Предложил Быков Никита 15.10.2014 18:01:13

Гибкое конфигурирование нового виз. редактора

Было бы здорово иметь возможность кастомизировать новый визуальный редактор.

Вероятно базовые настройки можно было бы задавать как и раньше - в настройках модуля, а более гибкие параметры можно передавать с помощью массива настроек, как это сделано в том же TinyMCE.

Также очень не хватает хотя бы базовых настроек и описания API нового виз. редактора.
Рейтинг: 2.8131  
Отложено
Предложил Постоев Олег 30.08.2014 14:53:47

В документации к методам и классам писать путь к php файлам, где они определены

Так будет легче изучать недокументированные возможности,  порой это очень нужно
Рейтинг: 0  
Ответил Басыров Роберт 05.12.2014 11:34:49
Модуль ЛивАПИ решает эту задачу. Есть ещё и проект в сети от АНтона Долганина: http://bxapi.ru/
Рейтинг: 1.5824  
На голосовании
Предложил Валерий Чебан 20.07.2014 00:29:09

Сделать немного UML диаграмм для модуля каталога с интернет магазином

В идеале хотелось бы увидеть диаграмму последовательности действий при работе с ценобразованием, а в особенности в каком порядке и какие события вызываются.
Рейтинг: 0.1937  
Новая
Предложил Постоев Олег 29.05.2014 22:14:30

Добавить в документации описание метода $DB->GetNowFunction()

Метод косвенно описан в описании метода CDatabase::Insert:
"TIMESTAMP_X" => $DB->GetNowFunction()
Хотелось бы подробностей :|
Рейтинг: 1.1615  
Отложено
Предложил Korban Michael 28.05.2014 14:09:17

Документация одновременно с обновлениями.

Сегодня столкнулся с неприятной ситуацией, когда после очередного "стабильного" обновления перестал работать код:

$res = CTasks::GetList(
                    Array("ID" => "ASC"),
                    Array(
                        "RESPONSIBLE_ID" => $userId,
                        "FORUM_ID" => $forumId
                    )
                );
 
Как оказалось, теперь поле FORUM_ID не является допустимым для использования в фильтре, однако в документации это не отражено, в результате чего пришлось изучать исходный код в поисках причины пропавшей работоспособности.

Ранее об этом уже упоминалось, но хочется еще раз поднять вопрос о том, что бы для обновлений был максимально подробный changelog, что бы было понятно заранее к чему готовится. Кроме этого, я бы предпочел, и думаю, что я не один такой буду, кто был бы готов подождать обновлений, но зато что все изменения были задокументированы.
Рейтинг: 0  
Ответил Басыров Роберт 04.12.2014 19:01:50
Это нереализуемо. Новый функционал редко когда выходит в полном заявленном объёме, тем более бывает что пропускаются ошибки.
Разработчики откладывают написание доки до появления реально стабильной работы своих модулей.
Рейтинг: 26.0704  
На голосовании
Предложил Задойный Алексей 29.04.2014 09:58:38

Методика измерения "времени загрузки" при внедрении технологии Композит


Необходима методика измерения "времени загрузки" до и после внедрения технологии Композит (то, что в рекламе уменьшилось в 100 раз).

  • Методика должна быть обоснована (именно то что в презентации описывается в презентации и на http://www.1c-bitrix.ru/composite/, в понятных пользователю терминах, чтобы можно было сравнить с увиденным на экране)
  • Методика должна быть доступна к реализации простому пользователю (описаны инструменты, где их взять, как настроить, как использовать)
  • Методика должна быть проиллюстрирована примерами на которых наблюдается заявленное Х100 ускорение сайта.
Сейчас абсолютно не ясно какая из цифр может считаться искомой.


Конкретное пособие по измерению, а не общие слова и теоретические выкладки. Теорию мы усвоили. Нужен практикум.
Рейтинг: 12.0181  
Новая
Предложил Постоев Олег 30.01.2014 12:27:47

Выводить примеры массивов в документации

Например для следующих методов:
CUser::GetByID 
CIBlockElement::GetByID 
CIBlockElement::GetList 
CIBlockElement::GetProperty 
Было бы очень полезно видеть ключи массива прямо в справке!
А то сейчас приходится исполнять код и смотреть какие ключи есть в результирующем массиве, что не всегда удобно и всегда занимает времени больше, чем могло бы быть.
Рейтинг: 12.4745  
Внедрено
Предложил Машанов Павел 01.10.2013 11:51:58

Changelog в документации

Порой добавляется интересная возможность, а в документации это лишь пара строчек  в середине текста.
Например SECTION_SCOPE в CIBlockElement::GetList.
В принципе это есть в описаниях обновлений, но как часто их читают?
Хорошо бы иметь changelog для страниц документации api. Тогда сразу видны новые возможности.
Рейтинг: 0.0661  
Ответил Басыров Роберт 19.12.2013 17:13:41
В данный момент ведётся работа по простановке версий сущностей и параметров.
Рейтинг: 35.4775  
На голосовании
Предложил Семочкин Михаил 26.03.2013 13:01:08

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

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

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

Если бы попутно отмечалось бы с какой по какую версию существует та или иная функция/событие, то было бы еще лучше.
Рейтинг: 19.1348  
На голосовании
Предложил Рычагов Сергей 14.11.2012 12:58:11

Документация к настройкам

Модули Битрикса имеют очень много настроек. Эти настройки не всегда очевидны. Установка того или иного значения не известно к чему приведёт, какой результат будет получен от включения или изменения настройки. Почему бы рядом с настройкой на поставить хинт, подсказку, с описанием этой настройки. Этот хинт можно залинковать на отдельную страницу, где будет официальная документация от Битрикса к настройке (написанная простым понятным языком), а также комментарии пользователей (в том числе приёмы использования, не стандартное использование и т.д.). Трачу значительное количество времени на поиск документации к настройке, а если не нахожу её, то приходится обращаться в ТП. Мне кажется это было бы очень удобно!