Прежде чем перейти к статье, хочу вам представить, экономическую онлайн игру Brave Knights, в которой вы можете играть и зарабатывать. Регистируйтесь, играйте и зарабатывайте!
Привет, Хабр! Я Ульяна, старший аналитик в направлении продуктового и системного анализа в отделе Tinkoff Mobile Core. Наш отдел разрабатывает общие технические решения — библиотеки, которые используются в мобильных приложениях экосистемы Тинькофф.
Для наших коллег мы проектируем документацию и инструкции для разрабатываемых библиотек, различных общих проектов и исследований. Вот главные требования к документации: она должна быть максимально понятной и структурированной, а поиск — легким и быстрым.
Документацию мы ведем в Confluence — и обычно, когда я рассказываю про Confluence, у многих он вызывает, мягко говоря, неприятные ассоциации. Миллион разделов, неудобная навигация, портянки бесконечного текста и многое другое, что отбивает желание даже открывать любую wiki. Но я спешу вас обрадовать — все может быть совсем иначе!
Расскажу, как выжать максимум из Confluence, чтобы вы могли научиться использовать макросы и другие его возможности и с помощью них быстро проектировать понятную и удобную документацию.
Что такое Confluence и зачем он нужен
Confluence — это инструмент, предоставляющий функциональность для создания командных пространств, в котором хранятся все накопленные знания. Эти знания объединены с возможностями для совместной работы.
Confluence используют для:
Ведения и хранения проектной документации и рабочих материалов.
Структурирования всей информации в едином месте.
Совместной командной работы в режиме реального времени.
Оптимизации командных и проектных процессов.
Основные инструменты для работы в Confluence — макросы, разметка, метки и шаблоны.
Макросы — один из основных инструментов в Confluence. Макросы — это БА-А-АЗА!
Макросы позволяют делать таблицы, уведомления, оформление текста, вкладки и еще много-много всего.
Дисклеймер!
Важно знать и помнить:
Не все макросы доступны из коробки и бесплатны. Будьте готовы к тому, что какие-то из перечисленных макросов могут отсутствовать или, наоборот, не описаны в этом списке, потому что отсутствуют у меня
Интересные статьи
Интересные статьи
