Так уж получается по жизни, что документация отстает от того, что делают разработчики. Это связано со со многими причинами. В частности с тем, что трудно бежать впереди паровоза. Или вместе с паровозом. Хотя пытались.
При создании Руководства по инсталляции продукта в этот раз попытались не ждать релиза, а писать документацию одновременно с разработкой нового инсталлятора под седьмую версию. Запыхались. То одно изменят "зловредные" разработчики, то другое. Не получилось выпустить даже Руководство по инсталляции одновременно с продуктом.
Но опоздание, все же не такое ужасающее, на мой взгляд.. Всего на две недели от официального релиза задержали. А если учесть, что руководства не просто подогнаны под новый интерфейс и функционал, но и существенно переработаны и дополнены, то задержку считаю вообще несущественной.
Под обязательной документацией мы понимаем:
;
;
;
, как "облегченная версия" Руководства по интеграции
Теперь на очереди - курсы. Часть из них будет просто адаптироваться под новый интерфейс и функционал. Но будут и изменения посерьезнее. Об этом в следующем сообщении, когда все в понимании изменений курса утрясется и обдумается.
А вот по поводу документации очень нужны мнения партнеров и пользователей. Что не так? Где не дорабатываем, где пропускаем?
Про документацию API - знаю.. Это самый больной вопрос. Но решаем. Сложность в том, что программистам проще написать 10 страниц кода, чем 10 строк осмысленного человеческого текста. Один из них прямо так и сказал, что к концу первой страницы написания документации к собственному коду ему хочется чем-то тяжелым запустить в окно...
Итак, резюме.
Весь пакет обязательной документации готов. Пользуйтесь. Будут замечания и соображения какие - пишите.
Наверно, в этом случае, желательно работать совместно работать программерам и документальщикам. imho
1. Мастерклассы по отдельным модулям.
- например, о настройке и использовании модуля рекламы.
2. Know-how/cooking book (много маленьких заметок и удобных инструкций для настройки тех или иных вещей)
- например, классно сделали описание изменения дефолтной навигации
- сделайте маленькую инструкцию о том, как вывести "следующая новость -> " "<- предыдущая новость"
То есть обязательная документация это замечательно, замечательно и мануалы. Это нужно.
Как я понимаю конкурс на лучшие партнерские модули провалился?
А почему бы не сделать конкурс на лучшее know how по совершенствованию публичной части продукта?
Давать приз за лучшую подробную статью/инструкцию, - она не обязательно должна быть большой или сложной.
Результатом в идеале должен стать свой "магазин идей" как это реализовано на сайте individ.ru для клиентов компании.
До этого читал сообщения о новых редакциях от Сергея Рыжикова, поэтому такое обращение в начале сообщения
Для API прикрутим к документации возможность добавлять комментарии. ТУт будет для вас широкое поле деятельности.
Конкурс на лучшее know how - подумаем.
1. Частная документация по модулю "Реклама"
Информация о том как реализовать и предоставить рекламодателям все популярные рекламные возможности на интернет-проекте:
- растяжки на весь экран (600*90)
- статичные баннеры
- pop-up'ы
Можно ли вывести статистику для рекламодателей в публичную часть?
Можно ли дать рекламодателем права для изменения рекламного материала?
Модуль с очень большими возможностями, которые я думаю мало кто использует на 100%.
2. Частная документация по модулю "Статистика"
Здесь больше о возможностях анализа собственного сайта и анализа рекламных компаний.
Я помню Сергей Рыжиков делал презентацию в Питере этого модуля очень красочно, однако, на примере демо-сайта с нулевыми показателями.
Было бы интересно увидеть обзор возможностей, в частности видео-презентация - замечательная идея.
3. Большое количество know-how по модулю инфоблоков.
Не думаю что частная документация для пользователей нужна, а вот множество примеров - точно.
Дело в том, что модуль:
- с одной стороны, очень простой и понять что и как там создается легко.
- с другой стороны, это чаще всего ядро проекта и обладает колоссальным потенциалом, который нужно настраивать как в администраторской части (здесь можно заказать разработки у партнеров), так в большей части в публичной части (здесь хотелось бы увидеть многообразие вариантов, красивое голосование/комментирование/рейтинги и другие возможности).
Добавлены описания новых компонентов. В настоящее время встретятся две формы оформления страницы: старая и новая, не пугайтесь.
Просто мы переходим к более удобной и понятной форме страницы, когда в одной таблице сводятся описания полей в GUI форме настройки, соответствующего этому полю название параметра в коде компонента и описание самого параметра. В старой форме такого соответствия имени поля и имени параметра не было, что было не правильно. Вот исправляемся, но сделать быстро это не получается.
В связи с тем, что придется отвлекаться на написание документации по готовящемуся новому релизу Корпортала, решили выложить CHM "как есть", что бы немного облегчить участь тех, кто предпочитает CHM он-лайновой доке.
В течение месяца будет обновлен и CHM для разработчиков.