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

март 2014
О клубе
ya-events
25 марта 2014, 20:40
Клуб для общения технических писателей на профессиональные темы. Открыт для всех, кто интересуется вопросами документирования, готов делиться своим опытом и перенимать опыт коллег.

Молодым специалистам будет полезна рубрика «Азбука техписателя», в которой публикуются статьи об основах профессии.
 
Приглашаем всех желающих рассказывать о различных аспектах работы технического писателя. Приветствуются публикации на следующие темы:
  • разработка и локализация документации;
  • написание технических текстов;
  • организация процесса: взаимодействие с заказчиками, контроль качества, учет задач;
  • инструменты, используемые в работе;
  • введение в специальность.
     
Делитесь в клубе своими методиками и подходами, интересными статьями и исследованиями о техническом документировании, анонсами конференций.
Задавайте вопросы коллегам и помогайте советами другим.

 

Чтобы подписаться на уведомления о публикациях в клубе, перейдите по ссылке.

 
2 комментария
Заголовок не указан
ya-events
25 марта 2014, 20:41
Помните, клуб создан только для обсуждения профессиональных вопросов работы технических писателей.

В клубе приветствуется:
  • Обмен полезными профессиональными материалами.
  • Взаимопомощь при решении профессиональных вопросов.
  • Любое профессиональное общение, благодаря которому будут вырабатываться общие подходы к разработке хорошей документации.

В клубе можно:
  • Задавать вопросы о документировании в Яндексе.
  • Оставлять отзывы на документацию, разрабатываемую в Яндексе.
  • Давать ссылки на образцы хорошей по наполнению или оформлению документации.

В клубе запрещено:
  • Писать сообщения, противоречащие законодательству РФ.
  • Оскорблять других участников клуба и использовать нецензурную лексику.
  • Размещать материалы эротического характера.
  • Размещать рекламу.
  • Размещать записи, не соответствующие теме клуба.

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