Confluence и collaborative documentation: возможности и подводные камни, Светлана Новикова, IPONWEB, CEE-SECR 2017

Atlassian Confluence – широко используемый инструмент в области корпоративной документации и управления знаниями, у него есть широкие возможности, но и немало ограничений. В докладе я поделюсь своим видением работы с документацией и системой управления знаний на Confluence. Акцент будет сделан на общем подходе к организации базы знаний, иерархии документов, процессу ревью и настройке шаблонов и интеграций с плагинами. Речь пойдет об общей функциональности версий 5.9 и выше.

Transcript

1. Copyright © 2017 IPONWEB GmbH Confluence и Collaborative Documentation: возможности и подводные камни Svetlana Novikova, Technical Writer of the Development Practice
2. Copyright © 2017 IPONWEB GmbH ➔ IPONWEB разрабатывает платформенные решения для рынка Online Advertising ➔ Отрасль: AdTech ➔ Язык: Английский ➔ Стек документации: Confluence, Sphinx (Single-HTML), Swagger API Profile
3. Copyright © 2017 IPONWEB GmbH
4. Copyright © 2017 IPONWEB GmbH Проблема VS
5. Copyright © 2017 IPONWEB GmbH Проблема
6. Copyright © 2017 IPONWEB GmbH Before: Типичный новый разработчик/PM
7. Copyright © 2017 IPONWEB GmbH Before: В то же время технический писатель
8. Copyright © 2017 IPONWEB GmbH Before: Опытный разработчик
9. Copyright © 2017 IPONWEB GmbH Подход: Collaborative Documentation
10. Copyright © 2017 IPONWEB GmbH
11. Copyright © 2017 IPONWEB GmbH ВСЕ ПРОТИВ ВСЕХ ДЛЯ
12. Copyright © 2017 IPONWEB GmbH Confluence - гетто для документов
13. Copyright © 2017 IPONWEB GmbH Очень. Много. Правок
14. Copyright © 2017 IPONWEB GmbH Отсутствие единой структуры и подхода к оформлению
15. Copyright © 2017 IPONWEB GmbH Идеальный мир Разработчики сами ищут информацию в базе знаний Активно делятся знаниями
16. Copyright © 2017 IPONWEB GmbH Меняем подход к документации Structure Структура пространства должна быть логичной, а правила понятными и одинаковыми для всех Context Документация помещается в бизнес-контекст. За технической задачей стоит бизнес-задача. Complex Документация - часть процесса передачи знаний (в комплексе с другими элементами), а знания связные и неизолированные
17. Что изменилось? 17
18. Copyright © 2017 IPONWEB GmbH Часть про “Как?” Инструменты: Confluence
19. Какие инструменты в рамках Confluence нам доступны
20. Copyright © 2017 IPONWEB GmbH Инструменты Шаблоны Разметка Лейблы Ревью Динамический контент
21. Copyright © 2017 IPONWEB GmbH Шаблоны/Templates Ну привет, синдром пустой страницы
22. Copyright © 2017 IPONWEB GmbH Шаблоны/Templates Ну привет, синдром пустой страницы
23. Copyright © 2017 IPONWEB GmbH Идеальный документ разработчика
24. Copyright © 2017 IPONWEB GmbH Шаблоны/Templates Настройте шаблоны для удобства других пользователей Преднастроенный текст Переменные
25. Copyright © 2017 IPONWEB GmbH Шаблоны/Templates Добавлены макросы Страница уже структурирова на Проставлены лейблы и материалы по теме
26. Copyright © 2017 IPONWEB GmbH Создать из шаблона Шаблоны/Templates
27. Copyright © 2017 IPONWEB GmbH Разметка/Layout Page Layout: Panel, Section, Column + color blocks
28. Copyright © 2017 IPONWEB GmbH Разметка/Layout Динамический контент Панели Создать из шаблона
29. Copyright © 2017 IPONWEB GmbH Разметка/Layout Динамический контент Панели Создать из шаблона
30. Copyright © 2017 IPONWEB GmbH Label Content • Преодоление ограничений поиска • Возможность агрегировать контент определенной тематики в одном месте в виде своеобразного RSS Feed (Content by Label) • Структурирование и связность С чего начать: ❏ Посмотреть список всех labels yourconfluencesite.com/labels/list-labels- alphaview.action&key=SPACENAME ❏ Найти весь контент без labels: type:page NOT labelText:[a TO z] NOT labelText:[0 TO 9]
31. Copyright © 2017 IPONWEB GmbH Агрегировать весь контент по лейблу Content by Label Можно отфильтровать по спейсу, по пользователю,
32. Copyright © 2017 IPONWEB GmbH Make Documentation Great Again
33. Copyright © 2017 IPONWEB GmbH QUESTIONS?
34. Светлана Новикова 34 ➔ Технический писатель группы разработки компании IPONWEB ➔ Ссылка на все ссылки http://bit.ly/2fLoBuo Контакты: ▪ snovikova@iponweb.net ▪ https://www.facebook.com/svetl novikova
35. Copyright © 2017 IPONWEB GmbH f iponweb.com