Embed Size (px)
DESCRIPTION
Документирование блоков. Раскрываем все плюсы Мы поговорим о том, как разрабатывается техническая документация к библиотеке bem-components и почему разделение интерфейса на блоки облегчает работу с документами как техническим писателям, так и разработчикам. А также о том, как мы выкладываем всю информацию по каждому блоку с примерами и JSDoc на наш сайт ru.bem.info. Инна Белая, Яндекс Разработчик технической документации в бригаде документирования БЭМ. В Яндексе с 2013 года.
Citation preview
Документирование блоков. Раскрываем все плюсы
Инна Белая, разработчик технической документации
О чем поговорим
Документирование блоков. Раскрываем все плюсы 3
О чем поговорим
Где можно найти нашу документацию
Документирование блоков. Раскрываем все плюсы 3
О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Документирование блоков. Раскрываем все плюсы 3
О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Какие принципы мы используем для ее разработки
Документирование блоков. Раскрываем все плюсы 3
О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Какие принципы мы используем для ее разработки
Как и что мы пишем
Документирование блоков. Раскрываем все плюсы 3
Где найти документацию?
Документирование блоков. Раскрываем все плюсы
Процесс сборки и выкладки документации
Документирование блоков. Раскрываем все плюсы
Инструменты
Процесс сборки и выкладки документации 9
Инструменты
github.com/bem/bem-site-engine
Процесс сборки и выкладки документации 9
Инструменты
github.com/bem/bem-site-engine
github.com/bem/bem-data-source
Процесс сборки и выкладки документации 9
Отображение на сайте
Процесс сборки и выкладки документации 10
Андрей Кузнецов
bem.info – движок и сайт
Плюшки
Процесс сборки и выкладки документации 12
Плюшки
Многоуровневая структура сайта
Процесс сборки и выкладки документации 12
Плюшки
Многоуровневая структура сайта
Контроль версий
Процесс сборки и выкладки документации 12
Плюшки
Многоуровневая структура сайта
Контроль версий
Переопределение ссылок
Процесс сборки и выкладки документации 12
Плюшки
Многоуровневая структура сайта
Контроль версий
Переопределение ссылок
Система тегов
Процесс сборки и выкладки документации 12
Плюшки
Многоуровневая структура сайта
Контроль версий
Переопределение ссылок
Система тегов
Лёгкость поддержки сайта с документацией
Процесс сборки и выкладки документации 12
Принципы разработки документации по БЭМ
Документирование блоков. Раскрываем все плюсы
Базовые принципы
Принципы разработки документации по БЭМ 14
Базовые принципы
Принцип атомарных сущностей
Принципы разработки документации по БЭМ 14
Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Принципы разработки документации по БЭМ 14
Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Принципы разработки документации по БЭМ 14
Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Гибкое версионирование
Принципы разработки документации по БЭМ 14
Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Гибкое версионирование
Использование БЭМ-инструментов для сборки
Принципы разработки документации по БЭМ 14
Организация файловой системы
Принципы разработки документации по БЭМ 15
Порядок во всем
17
Что и как мы пишем?
Документирование блоков. Раскрываем все плюсы
Структура документации к блоку
Что и как мы пишем? 19
Структура документации к блоку
JSDoc
Что и как мы пишем? 19
Структура документации к блоку
JSDoc
Документация в формате MarkDown
Что и как мы пишем? 19
Структура документации к блоку
JSDoc
Документация в формате MarkDown
Инлайновые примеры
Что и как мы пишем? 19
JSDoc
Что и как мы пишем? 20
JSDoc
Автоматически собираемая документация
Что и как мы пишем? 20
JSDoc
Автоматически собираемая документация
Пишется разработчиками как комментарии в коде
Что и как мы пишем? 20
JSDoc
Автоматически собираемая документация
Пишется разработчиками как комментарии в коде
Содержит описание публичных методов блока
Что и как мы пишем? 20
JSDoc
Автоматически собираемая документация
Пишется разработчиками как комментарии в коде
Содержит описание публичных методов блока
Доступна только на английском языке
Что и как мы пишем? 20
Описание блока
Что и как мы пишем? 21
Описание блока
Содержит все функциональные возможности блока
Что и как мы пишем? 21
Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Что и как мы пишем? 21
Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Доступно на русском и английском языках
Что и как мы пишем? 21
Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Доступно на русском и английском языках
Пишется техническими писателями совместно с разработчиками
Что и как мы пишем? 21
Инлайновые примеры
Что и как мы пишем? 22
Инлайновые примеры
Пишутся непосредственно в описании блока
Что и как мы пишем? 22
Инлайновые примеры
Пишутся непосредственно в описании блока
Собираются на сайт автоматически
Что и как мы пишем? 22
Инлайновые примеры
Пишутся непосредственно в описании блока
Собираются на сайт автоматически
Предоставляют BEMJSON, HTML и наглядный пример для каждого случая
Что и как мы пишем? 22
Исходный вид документации
Что и как мы пишем? 23
Отображение на сайте
Что и как мы пишем? 24
Документация на сайте bem.info
Что и как мы пишем? 25
Спасибо за внимание!
Документирование блоков. Раскрываем все плюсы 27
Инна Белая
Разработчик технической документации
Контакты
inna__neige@twitter
