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

сентябрь 2015
Как правильно указывать аудио, видео и мультимедийные материалы в разделе документации об используемых материалах?
bryston
4 сентября 2015, 08:03

Коллеги, подскажите, есть ли отечественные или зарубежные стандарты, с помощью которых можно указывать аудио, видео и мультимедийные материалы в разделе документации об используемых материалах?

Приведу примеры, как принято указывать печатные издания в документации:

  1. Новиков Ю. В. Основы цифровой схемотехники. — М. Мир, 2001.
  2. Хоровиц П, Хилл У. Искусство схемотехники: В 3-х томах: Пер. с англ. — 4-е изд., перераб. и доп. — М.: Мир, 1993.
  3. Журнал «Русский репортер», №21-28, 2011.
  4. Science Journal, № 332, 2011.
  5. Энциклопедия для детей. Том 22. «Информатика» — М. Аванта+, 2008. 

Если подобных стандартов нет, пожалуйста, поделитесь опытом, как Вы указываете вышеназванные материалы в тех или иных документах, скажем, Крылов В. И. Как научиться работать с базами данных? - Россия. Юни-Студио, DVD 234-090, 2012 или John Dale. A true words about data bases. - UK. EMI, CD 898-90-672 DDD, 2015.

Заранее спасибо!

5 комментариев
Стайл-гайд Яндекса
firstbon
4 сентября 2015, 08:03

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

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

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

Спасибо!

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

9 комментариев
Шаблон для подготовки документов по ГОСТ ЕСПД с использованием Docbook v.5
eduard-tibet
4 сентября 2015, 15:36

Доступен шаблон (docbook xsl customization layer) для подготовки документов с использованием Docbook 5 и соответствующих требованиям ГОСТ ЕСПД. Распространяется по лицензии GPLv3.

Подробности здесь: https://bitbucket.org/Lab50/espd-docbook5/

Там небольшая ошибка в описании. Для клона проекта надо сделать git clone https://bitbucket.org/Lab50/espd-docbook5.git

P.S. Проект не мой.

Нет комментариев
Зарубежный ГОСТ 34.201-89
bryston
24 сентября 2015, 09:51

Коллеги, в каком зарубежном стандарте (аналог российского ГОСТ 34.201-89 "ВИДЫ, КОМПЛЕКТНОСТЬ И ОБОЗНАЧЕНИЕ ДОКУМЕНТОВ ПРИ СОЗДАНИИ АВТОМАТИЗИРОВАННЫХ СИСТЕМ") можно узнать о перечне документов, разрабатываемых на различных стадиях создания информационных продуктов?

Спасибо.

5 комментариев