Форум

Добрый день. Страшно слышать от руководителя отдела документации про отсутствие документации и неизвестные сроки.

А что насчёт документации d7 интернет-магазина?
Мне понравились тенденции, например, в направлении описания создания собственных обработчиков доставки, платёжных систем, ограничений. Здесь приводится как пример встроенный обработчик службы СПСР. Там уже есть комментарии в коде в стиле phpDocumentor. Это хороший знак. И есть даже некоторый задел для документации. Но этого мало. Там не описывается механизм работы Bitrix\Sale\Delivery\Services\Manager, который вызывает кастомные обработчики. Нет описания основных наследуемых методов. И даже в имеющемся курсе, куда была приведена ссылка выше, описание было дано в разделе "Примеры". Нет описания профилей (isProfile()) службы доставки и для чего это. Не сказано, что такое совместимость (isCompatible()). Как можно использовать ExtraServices, если о них ни слова не сказано?

Конечно, пример есть. Обработчик СПСР. И есть имена методов, переменных. Но это не документация для комфортной разработки. Документация - это когда не тратишь на попытки понять, как же использовать инструмент, несколько суток.

P.S. Отсутствие документации - очень негативно сказывается на репутации фреймворка. Когда Тейлора Отуэлла, разработчика Laravel, спросили: «Стоило ли так много времени тратить на документирование?», он ответил, что лучше задержит релиз Laravel 5.1, чем выпустит его с плохой документацией.

Руслан Мухамедьяров, изменена немного структура документации пользовательской, а поисковики ещё не переиндексировали.

Это не риторический.