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

Стайл-гайд Яндекса

firstbon
4 сентября 2015, 08:03

Здравствуйте!

На последнем Гипербатоне Татьяна Грачёва отвечала на вопрос Максима Ильяхова и сказала о возможности публикации стайл-гайда для технических писателей.

Опубликовали ли его? Если нет, можете ли поделиться со мной? Дело в том, что я хочу стать техническим писаталем и любю Яндекс − мне бы очень пригодилось ваше руководство.

Спасибо!

Отредактировал tl-69. Убрал почту, чтобы не донимали спамеры.

9 комментариев
Подписаться на комментарии к посту

Спасибо за интерес!

Мы продолжаем думать над тем, в каком формате и объеме выкладывать информацию из гайда.
Следите за новостями клуба :-)

Коллеги, с удовольствием читаю все, что попадается по стилистике написания и оформления документации в различных компаниях (когда это возможно), но просматривая документы Яндекс (выложенные в Интеренете), понял, что здесь речь идет только о пользовательской документации, а такие вещи как ГОСТ 34 или ГОСТ 19 не используются. Тогда встречный вопрос техписам из Яндекса: когда создавался Ваш корпоративный стайлгайд, анализировались ли вышеупомянутые ГОСТы, чтобы почерпнуть оттуда нужную информацию, например, касающуюся оформления документов?

просматривая документы Яндекс (выложенные в Интеренете), понял, что здесь речь идет только о пользовательской документации

Помимо пользовательской документации мы также разрабатываем техническую. С ней можно ознакомиться на сайте https://tech.yandex.ru

вопрос техписам из Яндекса: когда создавался Ваш корпоративный стайлгайд, анализировались ли вышеупомянутые ГОСТы, чтобы почерпнуть оттуда нужную информацию, например, касающуюся оформления документов?

При разработке руководства по стилю мы опирались на разные источники, в том числе -- на ГОСТы. Оценить (в процентах или долях) вклад каждого из них в итоговое руководство сложно, если вообще возможно.

Присоединяюсь к просьбе топик-стартера. Давно ждем, за новостями следим...

А вот стайл гайд Мейлчимпа, тоже очень полезный. Может, пригодится: http://styleguide.mailchimp.com/

спасибо, обязательно посмотрю

Кирилл Богатов
5 октября 2015, 13:01

А есть ещё примеры?

Виктор Фигурнов
7 октября 2015, 08:56

Apple Style Guide ссылка

IBM Style Guide ссылка

IEEE Editorial Style Manual ссылка

IEEE-SA Standards Style Manual ссылка

Microsoft Manual of Style 4th Edition ссылка

Microsoft Russian Style Guide (2011) ссылка

SAE Technical Paper Style Guide ссылка

U.S. Government Printing Office Style Manual ссылка

WHO Style Guide ссылка