Работа за год

Затребовал наш уважаемый гендиректор отчет о работе отдела документации за этот год. Подняли мы все наши записи в корпоративном портале, составили единый список и сами приятно удивились тому как много сделано.

Подумалось, а почему бы и не рассказать о том, как мы сработали в этом году?

Итак.

1. На "содержании" у нас четыре продукта (БУС, БУС-NET, КП и SAAS) и раздел Документация у нас на сайте.

2. Эти продукты обслуживают 6 видов документации: Онлайн дока (она же - CHM), комментарии к ней, руководства, учебные курсы, видеоролики, файлы help в дистрибутивах, книги.
[spoiler]

По продуктам.
"1С-Битрикс: Управление сайтом":

1. Создано и отредактировано 199 страниц API и 675 - пользовательской. Здесь добавление новой информации и актуализация документации под текущие версии. Самая объемная и самая незаметная внешне работа.

2. Комментарии к доке. Оказалось, что это очень удобная форма. На форуме уже встречаются прямые ссылки на такие комментарии. Значит нужная "весчь". За примерно 9 месяцев существования подано более 300 комментов. Из них опубликовано - 227. Благодаря многим комментам исправлены ошибки в документации. Как пустяковые, обычные описки, так и ошибки в кодах. Спасибо всем, кто не ленится делиться своим опытом и помогает нам в исправлении ошибок.

3. Руководства. Создано новых - 11 штук, актуализировано старых - 7. Очень трудоемкий фронт работ, но надеемся, что и не бесполезный для вас.

4. Учебные курсы. Основной упор делался на поддержание курсов в актуальном состоянии, исправление ошибок и насыщение курсов видео. Отдельный вид работ - переработка курса Администрирование с разбивкой его на три части. Отзывы в целом были положительные, хотя нареканий на учебные курсы есть. Часть из них субьективна, но есть и объективные проблемы, решать которые будем в следующем году. В частности запросили разработку дополнительного функционала модуля Обучение. Думается, что этот функционал будет полезен не только нам, но и учебным заведениям (с учетом выхода КП для ВУЗов).

5. Видео - новое направление, начали активно развивать. Создано и обновлено несколько десятков роликов, создан специальный раздел для видео.

6. Вышла в Эксмо книга, продолжение первой. Дополнена до редакции Малый бизнес. Не оставляются попытки написать "Библию программирования на Битриксе". Поставлен вопрос по поводу стимулирования авторов. Вопрос руководством решен положительно, стимулы будут обсуждаться с партнерским отделом и сообщены в соответствующей группе экстранета "1С-Битрикс". Если "Библия" выйдет в следующем году, то будет поставлен вопрос о сертификации разработчиков.

"1С-Битрикс: Корпоративный портал"

1. Прежде всего, выделена в отдельный инфоблок пользовательская документация по КП. Расхождений между БУС и КП все больше и потому решено разделить пользовательскую (API останется единой) документацию на доку по БУС и доку по КП. Создание новой потребовало создания 534 страниц документации. (Документация пока еще не вывешена на сайт.)

2. Создано 5 новых руководств и актуализировано 3 старых.

3. Курсы учебные. Работа велась в обычном русле: актуализация под текущую версию. Сложность была в двойной работе, так как курсы входят в дистрибутив (в отличие от БУСовских).

4. Книга по КП. Обращаю партнеров внимание на эту книгу. Она сделана для ЛПР: Лиц, Принимающих Решения: Директоров, начальников департаментов. Имеет не технический, а организационный уклон, то есть что могут сделать в своих организациях руководители, имея в руках такой инструмент как корпоративный портал. Это издание - способ "аргументировать" ЛПР на приобретение "1С-Битрикс: Корпоративный портал".

"1С-Битрикс: Управление сайтом ASP.NET"

1. Создана "с нуля" пользовательская документация - пока 132 страницы. API документации в привычном виде онлайн доки не будет (так решил отдел .NET).

2. Создано 4 новых руководства, 1 актуализировано.

SAAS

Этим направлением почти не занимались, в силу отсутствия нового у разработчиков. Но к концу года появилась потребность и будет выпущено Руководство по SAAS для хостеров.

Сайт

Обычная работа контент-менеджеров по поддержанию актуальности информации. Плюс собраны в
отдельную "кучу" все видео, которые так и будут теперь выкладываться только на этой странице. Плюс - отдельный раздел для разработчиков типовых решений на базе Bitrix Framework. (Ничего нового, просто для облегчения нелегкого труда разработчиков все собрано в одном месте. )

Разное.
Помогаем отделу тестирования искать ошибки в дистрибутивах, помогаем ТП и маркетингу отвечать на тикеты по документации, помогаем писать контент для сайта DOTNET, помогаем "западникам" в работе над английской докой, отвечаем на вопросы пользователей в форумах, решаем тикеты по документации.

Вот.. вроде все.. Надеемся, что наш труд поможет вам, уважаемые партнеры, в вашей работе.
Сами всегда готовы выслушать как предложения, так и замечания по нашей работе. Критику конструктивную примем к исполнению, спорную - обсудим, неконструктивной - улыбнемся (не из злобы же говориться, а из-за недопонимания).

Удачи нам всем... Ой, что-то уже мандаринами запахло..