Работа по "овидючиванию" всех курсов на финишной прямой. Одновременно начали работу по проверке наших текстов на то что называется "тошнотность" и "водность". Радует то, что первые проверенные курсы показывают что наш стиль написания текстов практически не вылазит за принятые нормативы этих недостатков. [spoiler] Кроме этого мы попросили стороннюю компанию Documentat провести аудит нашей документации. Краткое резюме аудита: "В целом у вас всё хорошо, есть мелкие недочёты". Речь шла о подаче контента, а не о самом контенте. Мы знаем о том, что у нас недоописано, работаем над этим. Теперь об опубликованном.
Документация API Сделано. Добавлены методы в классы:
CIBlockXMLFile добавлен метод safeUnZip для распаковки zip-архивов без php-расширения zip_open.
\CIBlockFormatProperties добавлен метод clearCache.
Документация API D7 Сделано
В Библиотеке интерфейсов добавлено расширение (набор) иконок ui.icon-set
В Библиотеке интерфейсов добавлено описание Каталога элементов (ui.entity-catalog) – JavaScript-расширения для отрисовки каталога сущностей.
Кроме этого мы попросили стороннюю компанию Documentat провести аудит нашей документации. Краткое резюме аудита: "В целом у вас всё хорошо, есть мелкие недочёты". Речь шла о подаче контента, а не о самом контенте. Мы знаем о том, что у нас недоописано, работаем над этим. Теперь об опубликованном.
Ого! Отличная идея!
Было бы очень круто увидеть выступление на осенней конференции по поводу документации: какой путь прошли (с чего начинали, к чему пришли), какие планы, какие подходы пробовали, что зашло/не зашло. Как внутри компании мотивируете писать или выбиваете с паяльником
Да как начинали с графоманства и дублирования того, что и без них написано на языке программирования, так и продолжают. Достаточно взглянуть на любую другую документацию — они и оформлены лучше и читать их приятно и примеры кода адекватные. А тут, работу которую они проводят с докой за месяц... ну, это не похоже на работу. Написать что,
функция принимает на вход такие параметры (парам1, парам2), а выдаёт такие в случае ошибки (резерр) или успеха (резсак). Пример мертворождённый (помните ведь, что ни один из примеров нельзя копипастом проверить?) абсолютно оторванный от реальности: функтион(парам1, парам2) { ду самфинг; ретурн оаоаоа; }
Ну, вот я и написал подобие того, что можно прочитать фактически на каждой странице в доке. Почему за это им платят деньги и так долго держат — мне не известно, мне не понять.
- В класс \Bitrix\Iblock\PropertyTable добавлены
константы пользовательских типов свойств инфоблока.
Здравствуйте, это снова я) тут ошибка в ссылке.Странно, ссылки проверял, работало.
Спасибо за замечание!
Ого! Отличная идея!
Было бы очень круто увидеть выступление на осенней конференции по поводу документации: какой путь прошли (с чего начинали, к чему пришли), какие планы, какие подходы пробовали, что зашло/не зашло. Как внутри компании мотивируете писать или выбиваете с паяльником
функция принимает на вход такие параметры (парам1, парам2), а выдаёт такие в случае ошибки (резерр) или успеха (резсак). Пример мертворождённый (помните ведь, что ни один из примеров нельзя копипастом проверить?) абсолютно оторванный от реальности: функтион(парам1, парам2) { ду самфинг; ретурн оаоаоа; }
Ну, вот я и написал подобие того, что можно прочитать фактически на каждой странице в доке. Почему за это им платят деньги и так долго держат — мне не известно, мне не понять.