Документирование блоков. Раскрываем все плюсы
Мы поговорим о том, как разрабатывается техническая документация к библиотеке bem-components и почему разделение интерфейса на блоки облегчает работу с документами как техническим писателям, так и разработчикам. А также о том, как мы выкладываем всю информацию по каждому блоку с примерами и JSDoc на наш сайт ru.bem.info.
Инна Белая, Яндекс
Разработчик технической документации в бригаде документирования БЭМ. В Яндексе с 2013 года.
3. О чем поговорим
Документирование блоков. Раскрываем все плюсы 3
4. О чем поговорим
Где можно найти нашу документацию
Документирование блоков. Раскрываем все плюсы 3
5. О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Документирование блоков. Раскрываем все плюсы 3
6. О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Какие принципы мы используем для ее разработки
Документирование блоков. Раскрываем все плюсы 3
7. О чем поговорим
Где можно найти нашу документацию
Как мы собираем документацию на сайт
Какие принципы мы используем для ее разработки
Как и что мы пишем
Документирование блоков. Раскрываем все плюсы 3
22. Плюшки
Многоуровневая структура сайта
Контроль версий
Переопределение ссылок
Система тегов
Процесс сборки и выкладки документации 12
23. Плюшки
Многоуровневая структура сайта
Контроль версий
Переопределение ссылок
Система тегов
Лёгкость поддержки сайта с документацией
Процесс сборки и выкладки документации 12
27. Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Принципы разработки документации по БЭМ 14
28. Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Принципы разработки документации по БЭМ 14
29. Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Гибкое версионирование
Принципы разработки документации по БЭМ 14
30. Базовые принципы
Принцип атомарных сущностей
Документация – одна из реализаций блока
Хранение рядом с кодом
Гибкое версионирование
Использование БЭМ-инструментов для сборки
Принципы разработки документации по БЭМ 14
42. JSDoc
Автоматически собираемая документация
Пишется разработчиками как комментарии в коде
Содержит описание публичных методов блока
Что и как мы пишем? 20
43. JSDoc
Автоматически собираемая документация
Пишется разработчиками как комментарии в коде
Содержит описание публичных методов блока
Доступна только на английском языке
Что и как мы пишем? 20
46. Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Что и как мы пишем? 21
47. Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Доступно на русском и английском языках
Что и как мы пишем? 21
48. Описание блока
Содержит все функциональные возможности блока
Разрабатывается в формате MarkDown
Доступно на русском и английском языках
Пишется техническими писателями совместно
с разработчиками
Что и как мы пишем? 21
51. Инлайновые примеры
Пишутся непосредственно в описании блока
Собираются на сайт автоматически
Что и как мы пишем? 22
52. Инлайновые примеры
Пишутся непосредственно в описании блока
Собираются на сайт автоматически
Предоставляют BEMJSON, HTML и наглядный пример для
каждого случая
Что и как мы пишем? 22