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

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

Добро пожаловать!

Приветствуем вас, уважаемые коллеги!
На конференции YaC, прошедшей в октябре прошлого года, мы увидели большой интерес к нашему стенду и докладу о разработке документации на программные интерфейсы. Мы постарались ответить на все вопросы наших гостей, но успели рассказать далеко не все.
Сейчас в нашей стране нет уютного места, о котором знают все технические писатели, где они могут задавать любые вопросы на профессиональные темы и делиться опытом. Имеющиеся форумы часто ограничены тематикой, инструментом разработки или подходом к документированию.
Поэтому мы решили организовать клуб для широкого общения технических писателей и технических переводчиков на все тематики, связанные с разработкой и локализацией документации.
Разработка документации в Яндексе разнонаправленная. Мы планируем рассказывать в клубе о многих своих наработках, таких как:
  • написание технической и пользовательской документации;
  • документирование кода и генерации справочников из кода;
  • подготовка документации в форматах DITA и MarkDown;
  • система сборки документации;
  • локализационная разметка и система автоматизации переводов;
  • организация процесса документирования и контроля качества;
  • хранение исходников и учет документации;
  • инструменты разработки и локализации.
Конечно, мы занимаемся не всеми возможными направлениями и используем ограниченный нашими потребностями набор инструментов. Поэтому мы рады узнавать об опыте коллег и предоставлять площадку для обмена опытом во всех направлениях документирования и совместно развивать экосистему технического писательства.
Также у нас большой опыт обучения новых специалистов. Поэтому мы хотим вести просветительскую деятельность и рассказывать о профессии технического писателя молодым специалистам. Во избежание однобокого подхода, мы считаем важным привлекать корифеев специальности из разных школ.
Вступайте в клуб. Следите за нашими публикациями, присылайте свои статьи и вопросы, предлагайте темы для обсуждения.
О вопросах, не связанных с тематикой клуба, и предложениях о совместных мероприятиях пишите на нашу рассылку yandex-techdoc@yandex-team.ru
Нашу документацию вы можете найти на сервисах: