Клуб технических писателей

май 2017
Пятый Гипербатон. Регистрация открыта
Юрий
5 мая, 12:30

Добрый день,

С радостью сообщаем, что открылась регистрация на пятый Гипербатон.

Мероприятие состоится 3 июня в московском офисе Яндекса. Также можно присоединиться к  онлайн-трансляции.

Участие бесплатное, количество мест ограничено.

С этого года Гипербатон проводится в расширенном формате. Теперь это — профильная конференция по вопросам разработки документации и локализации контента.

Гостей ждут тематические секции:
- Документирование
- Локализация
- Инструментарий

Программу конференции анонсируем позже.

Да пребудет с вами Сила!

4 комментария
гипербатон,2017,конференция,яндекс
Программа пятого Гипербатона
Юрий
16 мая, 12:00

Добрый день,

Опубликована программа пятого Гипербатона, который состоится 3 июня в Москве.

Докладчиками на конференции выступят сотрудники Яндекса, Лаборатории Касперского, Positive Technologies и Сигнатек.

Напоминаем, что участие в конференции бесплатное, но необходимо зарегистрироваться. Регистрация закрывается 29 мая в 16:00 по московскому времени.

Количество мест ограничено. Мы просматриваем все заявки вручную, поэтому могут быть некоторые задержки в получении ответа по статусу участия.

Да пребудет с вами Сила!

8 комментариев
гипербатон,конференция,2017,яндекс
Структура базы знаний
Кирилл Богатов
22 мая, 17:27

Здравствуйте, коллеги!

Нашу документацию читают и технические специалисты, и обычные пользователи. Первым интересно устройство продукта, а вторым — решение задач. Проблема в том, чтобы угодить и тем, и другим.

Например, есть описание справочника. Технический специалист хочет знать о том, как этот справочник связан с другими объектами и настройками, какие нюансы есть в его заполнении.  Для обычного же пользователя этот справочник — лишь один шаг в решении задачи.

Мешать техническое и пользовательское описание нельзя, но и усложнять структуру тоже не хочется. Пока что склоняюсь к такому варианту:

  • Главная страница
    • Общая тема
      • Инструкция 1
      • Инструкция 2
        • Шаг 1
        • Шаг 2
      • Решение проблем
      • Технические нюансы
        • Справочник 1
        • Справочник 2

Беда в том,  что связь конкретного справочника с общей темой не всегда очевидна. А значит, читателю будет тяжело найти нужную статью.

Что вы думаете о такой структуре? Как можно сделать лучше?

6 комментариев
структура