Побывал в командировке в Москве на . Аудитория была достаточно большая: в зале около 200 участников и по уверениям организаторов еще столько же в он-лайн. Целей поездки было две:
посмотреть тенденции электронного обучения, понять что у нас "так" с этим, что "не так" и "камо грядеши" eLearning сам по себе.
попытаться понять насколько наш Битрикс как софт может отвечать потребностям ниши электронного обучения.
Как уже писалось ранее, проводится изменение системы сертификации специалистов по платформе Bitrix Framework. Сегодня вывешен первый курс .
Отличие создаваемой линейки курсов в том, что они теперь строятся по функциональному принципу. То есть курс не рассказывает о каком-то модуле, редакции "вообще", а рассказывает о системе "1С-Битрикс: Управление сайтом" с точки зрения человека, выполняющего определенную работу с системой.
Когда у сайта компании менялся дизайн было решено отказаться от раздела Статьи. В силу того, что:
вроде как есть блоги;
статьи во многом устарели;
их не так много.
Но оказалось что:
блоги как вид контента не во всех случаях удобны;
статьи устарели только PR-овские;
У некоторых партнеров есть желание поделится своим опытом.
Исходя из этого раздел решено возродить. Что и сделано. О чем и сообщаем.
Не обещаем регулярного пополнения статей. Но рассмотрим все инициативные предложения поделиться своим опытом. Возможно, часть сообщений блогов разработчиков (с из разрешения) будут также переоформлены в статьи.
Рост объемов работ, приходящихся на отдел документации, и стремление Гендиректора Рыжикова к интенсивному, а не экстенсивному развитию, (во я загнул!) поставили вопрос об изменениях в работе раздела. Тема эта давно крутилась в мозгах, обсасывалась с коллективом. НО пока не было согласия разработчиков на доработку модуля Обучение, все оставалось только в виде радужных надежд.
Теперь такое согласие на включение работ по модулю Обучение есть. Новый модуль будет к осени. Это позволит нам несколько изменить работу отдела. В чем будут изменения?
Затребовал наш уважаемый гендиректор отчет о работе отдела документации за этот год. Подняли мы все наши записи в корпоративном портале, составили единый список и сами приятно удивились тому как много сделано.
Подумалось, а почему бы и не рассказать о том, как мы сработали в этом году?
Итак.
1. На "содержании" у нас четыре продукта (БУС, БУС-NET, КП и SAAS) и раздел Документация у нас на сайте.
2. Эти продукты обслуживают 6 видов документации: Онлайн дока (она же - CHM), комментарии к ней, руководства, учебные курсы, видеоролики, файлы help в дистрибутивах, книги.
Создана страница со всеми видеоматериалами, которые имеются на данный момент в учебном (не PR) плане на нашем сайте. Это страница .
На этой странице собраны и систематизированы по продуктам имеющиеся видеоматериалы.
Кроме этого, решили оставить и старые Flash-ролики. Они устарели интерфейсно, но по принципам работы - актуальны.
Последняя закладка на странице - учебные видеоролики предоставленные компанией . Компания специализируется на учебном видео и представленные уроки просто подарила нам. За что им отдельное спасибо.
Ролики выложены не все что у них есть. Из их большого курса (49 уроков) отобраны 21, посвященные визуальному редактору. Тема визредактора в них раскрыта очень хорошо. Эти ролики можно рекомендовать клиентам для контент-менеджеров. Разработчикам ролики вряд ли что-то дадут.
Все новые видеоматериалы учебного характера теперь будут выкладываться не в блоге, а на этой странице.
В ближайшее время в разделе появится отдельная страница с учебными видео-материалами. На этой странице будут собраны все ролики со всех мест (курсы, блоги), структурированы. Надеемся, это сделает процесс обучения работы с системой более удобным.
А пока предлагаем вашему вниманию видео по бизнес-процессам.
Работа бизнес-процессов рассмотрена в плане Библиотеки документов, то есть вся работа осуществляется через публичную часть. Работа с инфоблоками в админке будет рассмотрена в следующем материале.
Тема получилась большая, пришлось резать ролик на три части.
Часть первая: Общее понятие о модулях Бизнес-процессы и Дизайнер бизнес-процессов, настройка на работу с бизнес-процессами.
ролик (32 М, 9 мин.)
Часть вторая: Создание шаблонов бизнес-процессов.
ролик (37 М, 12 мин.)
Часть третья: Запуск и исполнение бизнес-процессов
Видео по модулю Экстранет сделали на день позже чем планировалось: Camtasia Studio в эту неделю много выпендривалась, но мы ее победили!. Поэтому можем сказать: "На выходные с чистой совестью!"
Удалось частично решить проблемы со звуком. Ролик получился по времени довольно большой 11 минут 13 сек. Размер в пределах статистики: чуть меньше 5 мег на минуту видео. В сумме - 53,5 "метра".
На наш взгляд это потенциально новый способ подачи документации в видео формате. Раньше мы просто "овидючивали" некоторые моменты работы с элементами системы. Но пока ни разу не пытались создавать отдельное видео по работе с целыми модулями или темами. (Хотя еще при создании первой книги мелькала идея просто переложить на видео ее текст и показать то, что написано.)
Первая попытка показать работу с отдельным модулем. Чтобы убить двух зайцев: создать руководство и создать видео, был выбран новый модуль "Поисковая оптимизация".
Хотелось бы услышать замечания по подаче информации, по сценарию, по оформлению.
Про проблемы со звуком можно не говорить. Мы их знаем и пока не можем решить.
Работа над курсами по администрированию продолжилась созданием роликов для этих курсов. Сложностей в работе было не много по числу, но сложности были весомые.
Прежде всего, это сценарии. То что просто пишется в тексте оказалось не просто показать. (Татьяна Старкова, наш ведущий специалист по документации, наверное теперь лучше понимает кинорежиссеров, которым из сценария фильма нужно сделать высокопрофессиональный видеоряд, достойный Оскара. )
Трудно оказалось и снять исходный материал. Воспользовавшись отсутствием Гендиректора, окупировали его кабинет, что бы никто не мешал. И все равно из-за шумов (хлопки дверью, чьи-то разговоры за стенкой) приходилось переписывать отснятый материал. (Татьяна осваивает работу оператора.)
Другой трудностью было - "красивое" монтирование отснятого материала. Все предусмотреть и правильно показать, выделить. Спасибо создателям Camtasia Studio за отличные возможности программы. (Татьяна осваивает работу монтажера.)
Как бы там ни было, но курсы дополнены видеороликами. За 7 рабочих дней записано несколько часов видео, которые ужались в примерно 40 минут чистого времени роликов. Все ролики размещены на соответствующих страницах курсов. Вот некоторые ссылки:
;
;
;
.
Мы были бы очень признательны отзывам о нашей работе. Помогают ролики или так, пустая трата времени? Что в них так, что не так?
Если есть файлы документации в формате chm для изучения доки в режиме оффлайн, то почему бы не быть файлам курсов для изучения в том же режиме оффлайн? Подумали мы.
Подумали и сделали файлы в формате PDF для загрузки и изучения курсов. Естественно, что там нет тестовых вопросов. Но информация сохранена полностью. Может быть с картинками не очень удачно получилось, так как на он-лайн курсах мы можем сделать открытие большой картинки по клику на превью, а в pdf такого не получается.
Пока сделаны файлы для курсов "1С-Битрикс: Управление сайтом". Чуть позже появятся файлы для курсов "1С-Битрикс: Корпоративный портал".
Единственное чего не знаю, насколько данный документ востребован будет. Честно. Ни на форумах, ни в личном общении с разработчиками эта тема ни разу не всплывала. Возможно, что Microsoft'у виднее. И поскольку фактически и сделал Microsoft (с нашей стороны только приведение его к стандартному оформлению), то особо не расстроюсь, если статистика его загрузок будет не высокой.
Как отдельный положительный момент этого документа отмечу - описание установки "1С-Битрикс: Управление сайтом" на базу SQL Server Express. Раньше такого описания не было, мы ограничивались в документации по установке лишь базой MySQL, как входящей в "Битрикс Веб-окружение".
Этот момент отметила и наша поддержка сразу же. Теперь ей есть куда посылать пользователей при вопросах "Как поставить продукт на MS SQL?".
По просьбе того же саппорта в "Руководство по установке" добавлено пара примечаний, упоминание о моментах, которые нам казались очевидными. Это замечание про то, что архив с дистрибутивом надо распаковывать именно в корневую папку, а не куда-то в другое место. Нам казалось это понятным и естественным, а оказывается не все так просто. Страшно подумать, но кто-то, оказывается, может думать не так как мы и устанавливать продукт не в корневой папке!!!
Впрочем, это не первое подобное изменение. Помнится и в Руководстве по установке "1С-Битрикс: Корпоративный портал" пришлось делать замечание о том, что он устанавливается только на сервер, а на клиентские машины ничего не надо ставить.
В связи с этим просьба к сообществу. Есть моменты в документации, которые очевидны для нас, но вызывают вопросы ваших клиентов (или ваши). Пишите, сообщайте. Все подправим.
Впрочем, спасибо сообществу в целом за работу в комментариях к документации. Благодаря вашим замечаниям исправлено довольно много, несколько десятков, ошибок и внесено почти сотня дополнений, примеров. Отдельное СПАСИБО самым активным. "Вспомним их поименно..": Роман Забродин; ipn, 0987, logic, Иван Неслуховский, EvGenius, Алена Бабой.
О всех исправлениях мы сообщаем тому, кто заметил ошибку. Если вы написали замечание но вам не пришло такое сообщение, то это означает, что нам, документалистам, не с кем проконсультироваться. Разработчики, к сожалению, иногда ходят в отпуск и болеют.
И, конечно, без ответа остаются сообщения в комментариях к документации типа: "А как сделать то-то..." Напоминаем, что комментарии - это не форум.
"Во первых строках своего письма, дедушка Константин Макарыч, сообщу", что наконец-то сделаны Комментарии к пользовательской документации. Долго тянули с этим, но сделали. Соответственно сделана и страничка RSS, на которую можно подписаться .
Во-вторых, скажу, что в обеих документациях, в индексные страницы каждого модуля добавлена таблица компонентов 2.0. Со взаимными ссылками между API и пользовательской документациями. Эта работа начата на прошлой неделе и завершена будет на этой. Пример можно посмотреть . Система перекрестных ссылок будет развиваться. Советы, рекомендации, претензии принимаются.
НУ а теперь о главном.
Начинаем работу над курсами Администрирования. Может кто помнит, раньше были курсы администрирования по редакциям. Потом, в силу того, что не успевали актуализировать эти курсы в соответствии с текущей версией, эти курсы убрали.
Теперь пришло время поработать над курсом по администрированию.
Цели: 1. Облегчить работу учащихся над курсами. Тем, кто собирается работать со Стартом, нет необходимости изучать Инет-магазин. 2. Актуализировать курсы по текущей версии. Продукт сильно изменился и потому нужен новый курс с учетом всех изменений в "1С-Битрикс: Управление сайтом". 3. Облегчить подачу материала и разрешить некоторые спорные вопросы, на которые жаловались проходящие обучение.
Вместо одного курса теперь будет три: Условные названия: Администрирование Старт, Администрирование Эксперт, Администрирование Бизнес. В первый курс будут входит базовые вопросы администрирования, во второй - расширенные вопросы для модулей редакций Стандарт и Эксперт, в третий - все остальные (До Большого Бизнеса включительно).
Вопрос сертифицирования. Это первое что интересует всех, его уже задавали. Пересдавать старые сертификаты не придется. Новые пользователь должен будет получать в порядке накопления. Если успеют реализовать функционал зависимости курсов, то нельзя будет сдать второй курс, пока не сдан первый, и нельзя будет сдать третий, если не будут сданы первые два.
Вот пока и вся информация. В связи с вышесказанным просьба ко всем заинтересованным высказать свои замечания по поводу имеющегося курса. Прежде всего интересуют именно те моменты, которые вызывают сложности в понимании, недосказанные или плохоосвещенные темы и вопросы в курсе Администрирования.
Появление комментариев в документации для разработчиков на данный момент оправдывает себя. Комментарии к документации хоть и не всегда объемные, но появляются почти каждый день. Правда, к сожалению поля комментариев воспринимаются больше как окно для жалоб, чем как средство поделиться знаниями. Повторяю еще раз: пропускаться будет только то, что дает какую-то практическую помощь вашим товарищам.
Впрочем, рассматриваются все сообщения и даже если они не прошли, но в них есть полезное зерно, то все рано будут рассмотрены. Так по некоторым сообщениям произведены исправления ошибок, добавлены возможности в компоненты.
Обнаружилась еще одно полезное свойство, совсем даже не предполагавшееся нами. Меня давно мучала мысль как реализовать сбор полезных решений из форумов, которые просто теряются в общей массе сообщений. Включать в документацию - нельзя, не тот формат. Писать отдельные документы-руководства - тоже как-то не получается. ФАК - тоже не тот формат: вопросы бывают мелкие и не часто востребованные. Но нужные. Будем включать их в комментарии.
Создание комментариев вызвало объективную потребность у вас, наших партнеров и разработчиков, в получении самой свежей информации по создаваемым сообщениям. Просьбы о RSS появились практически сразу после первых комментариев.
Сообщаю, реализовано. Подписаться на RSS на комментарии можно .
При реализации RSS для комментариев возникла идея и создать RSS для самой доки. Как для разработчиков, так и для пользовательской. Суть проблемы аналогичная: документация пополняется, вам желательно иметь информацию о появившихся страницах. Постараемся в ближайшее время сделать и это. Если вам это нужно, конечно.
В появилась возможность для пользователей добавлять собственные комментарии к статьям.
Эта возможность преследует две цели:
1. Задокументировать неосвещенные на данный момент в Документации классы, функции, события. 2. Пополнить документацию примерами использования сущностей "из жизни", из опыта разработчиков конкретных web-проектов.
На данный момент созданы пустые страницы незадокументированных сущностей. Если вы обнаружите какие-то классы, функции, события не имеющие своей страницы в Документации, то просьба сообщить об этом здесь, в блоге, или в соответствующих темах форумов: или . Страницы будут созданы.
Комментарии модерируемые. Но использование информации из комментариев остается на страх и риск пользователей. Ответственность наша компания будет нести только за то, что перенесено из комментариев в основной текст страницы. Либо, если в комментарии появится пометка - "Этот комментарий одобрен разработчиками".
Ну вот, открыто новое направление работы для отдела документации - это ASP.NET.
Пока есть всего три документа: для разработчиков и пара пробных документов по .
CHM по API - первый вариант, начальный. Будет пополняться .
А вот документация по установке будет изменяться: переделываться под наши стандарты по документации и дополняться информацией по установке на IIS. Существующие документы делал САМ руководитель направления ASP.NET - Юра Тушинский, пока наш отдел был занят докой по Корпоративному порталу.
Ударная работа программистов не дает отдыха отделу документации..
Все наши планы они ломают выходом новых версий и новых продуктов. ОСень вообще жаркая получается: Корпортал и .Net. И по каждому продукту нужен свой комплект документации. Это вам не обновить доку с версии 6.5 до 7-ки, а писать все заново.. А тут еще и Маркетинг для своих акция требует отдельные документы.. Насели все на нас троих, бедных..
Но "броня крепка и танки наши быстры"... все сделаем, только время дайте. По Корпорталу выложен последний документ: Руководство по администрированию портала. Читайте, изучайте, отзывайтесь.
Вышла книга «1С-Битрикс: Постройте профессиональный сайт сами!» Как автор хочу высказать благодарность всем, кто помогал автору в создании этой книги: Прежде всего самому главному главному консультанту Дмитрию Вальянову, а так же: Ирине Юртаевой, Антону Ежкову, Максиму Смирнову, Диме Власову. А также всем остальным, кто вольно (или не вольно ) помогал в написании книги.
Мне, как автору очень бы хотелось получить обратную связь от читателей: что в книге "не так".. Что-то освещено не достаточно, что-то избыточно.. Буду очень признателен за такие отзывы.
Обновлена и . Принципиальных изменений, в сравнении с прежними курсами, не много, точнее всего одно. Мы стали рекомендовать при использовании многосайтовости второго типа несколько иной, на наш взгляд более "красивый и логичный", способ создания символьных ссылок. Старый способ сохранен в Курсе по многосайтовости, он по прежнему работоспособный.
Остальные изменения свелись к более системному и понятному изложению материала.
Параллельно с текущей работой над документацией мы начали и закончили "визуализацию" первой ласточки - курса . Практически каждый урок сопровождается видеороликом. Убирать старые флеш-ролики мы не стали, вдруг кому-то понадобится. Размеры роликов довольно большие. Но таковы веяния времени - высокоскоростной доступ все более доступен. Поэтому мы старались не экономить на качестве.
Один из роликов (4 минуты, 16,3 Мб.):
С удовольствием примем любые замечания по содержанию роликов и их графическому оформлению.
Следующая задача - "визуализация" курса "Визуальный HTML-редактор".
Но нас на данный момент интересует другое. Визуализировать курсы с конкретным содержанием - просто. Что трудного в составлении сценария, описывающего работу HTML-редактора? Все видно и наглядно. А вот попробовать описать процесс более абстрактный - это еще нам надо научиться.. Попробуем на примере курса "Многосайтовость" и надеемся на успех.
Всем добрый день! Хочу представить вашему вниманию два новых видеоролика, в которых наглядно показывается как работать c и как на сайте.
Многие из Вас наверняка умеют все это делать, а вот новичкам, надеюсь, понравится . Сейчас перед нами стоит цель научиться записывать понятное видео по новым возможностям продукта. Поэтому посмотрите и оцените, пожалуйста, нашу "пробу пера". Если у вас возникнут замечания, пожелания, пишите. Мы со своей стороны попытаемся их обязательно учесть.
Ну вот. Сегодня вышла вся по новой версии "1С-Битрикс: Управление сайтом". Кто-то скажет: "Давно было пора". Соглашусь и не соглашусь.
Так уж получается по жизни, что документация отстает от того, что делают разработчики. Это связано со со многими причинами. В частности с тем, что трудно бежать впереди паровоза. Или вместе с паровозом. Хотя пытались. При создании Руководства по инсталляции продукта в этот раз попытались не ждать релиза, а писать документацию одновременно с разработкой нового инсталлятора под седьмую версию. Запыхались. То одно изменят "зловредные" разработчики, то другое. Не получилось выпустить даже Руководство по инсталляции одновременно с продуктом.
Но опоздание, все же не такое ужасающее, на мой взгляд.. Всего на две недели от официального релиза задержали. А если учесть, что руководства не просто подогнаны под новый интерфейс и функционал, но и существенно переработаны и дополнены, то задержку считаю вообще несущественной.
Под обязательной документацией мы понимаем: ; ; ; , как "облегченная версия" Руководства по интеграции
Теперь на очереди - курсы. Часть из них будет просто адаптироваться под новый интерфейс и функционал. Но будут и изменения посерьезнее. Об этом в следующем сообщении, когда все в понимании изменений курса утрясется и обдумается.
А вот по поводу документации очень нужны мнения партнеров и пользователей. Что не так? Где не дорабатываем, где пропускаем?
Про документацию API - знаю.. Это самый больной вопрос. Но решаем. Сложность в том, что программистам проще написать 10 страниц кода, чем 10 строк осмысленного человеческого текста. Один из них прямо так и сказал, что к концу первой страницы написания документации к собственному коду ему хочется чем-то тяжелым запустить в окно...
Итак, резюме. Весь пакет обязательной документации готов. Пользуйтесь. Будут замечания и соображения какие - пишите.
Поэтому можем сказать: 
и пока не можем решить. 
Политика конфиденциальности