Как гасится реклама в окне справа: слева-вверху окошка рекламы есть серое ушко, щелкние по нему.
   Кафедра ИИТ (МЭИ)
Сегодня 22-Янв-2019, вторник,        

Документы ИИТ

Справочные материалы


Требования к оформлению научно-технических документов

Требования к оформлению научно-технических документов

  • Заголовку документа надо уделять значительное внимание. Он должен точно описывать содержание документа, но не быть длинным (примерно до 10 слов). Недостаточно в заголовке назвать предмет обсуждения, нужно описать также то, что производится с этим объектом. Второе обычно осуществляется отглагольными существительными, например "Расчет...", "Исследование...", "Моделирование...", "Построение...", "Анализ...", "Синтез...", "Описание...", "Проектирование...".
  • В конце любых заголовков, надписей, подписей, текстов внутри ячеек таблицы -- ТОЧКА НЕ СТАВИТСЯ. Во всех прочих случаях в конце предложения должна быть точка, даже если предложение заканчивается формулой.
  • Документ очень желательно дробить на логически завешенные части (рубрики, разделы). Очень полезно им давать заголовки и нумеровать. Причем традиционно вводная и заключительная части не нумеруются
  • Текст рубрики должен соответствовать  её заголовку, но не быть его продолжением. Например, если рубрика названа "Устройство усилителя", то первым предложением не должно быть "Он состоит из ....". Следует начать "Усилитель состоит из...". Рубрика не должна начинаться или кончаться рисунком или таблицей.
  • Если в некоторой части текста присутствует периодичность (то есть одна за другой следуют похожие по структуре описания, вычисления, рассуждения), то это рекомендуется оформить как таблицу.
  • Все (!) сокращения должны быть растолкованы (в том числе, и все обозначения в формулах). Например, должно пояснять даже то, что R - это сопротивление. Не общепринятые символы (например, "->" взамен "следовательно" или "*" как знак умножения) тоже следует пояснять.
  • Не используйте в тексте жаргонные сокращения (например "ф-ция", "лаба") и разговорную лексику ("горелый чип", "флешка", "заточен на"). Неприемлемы уменьшительные формы слов ("проводок" или "маленький" вместо "провод" или "малый").  Никогда не применяются местоимения в первом лице единственного числа (вместо "я рассчитал", "по моему мнению" пишут "мы рассчитали", "по нашему мнению").
  • Не следует впритык, не разделяя их словами, ставить рядом две аббревиатуры, или аббревиатуру и формулу (или число). Например, плохо будет "разрядность АЦП N=12", хорошо -- "для АЦП разрядность N=12". Если в предложение внедрена формула, не следует начинать ее со знака минус (можно спутать с тире).  
  • О применении терминов. Недопустимо в пределах одного документа одним символом обозначать разные величины или объекты. Например, если вы где-то назвали нечто "источником", то не следует в другом месте называть это "генератором". И наоборот, нельзя использовать одно обозначение для разных величин или объектов. Например, два разные сопротивления или резистора нельзя обозначать одним и тем же символом R.
  • Рисунки и таблицы размещаются непосредственно за их первым упоминанием в тексте, а описания информационных ресурсов -- обычно в конце работы. Каждый рисунок, таблица и публикация должны быть хотя бы раз упомянуты в тексте. Все рисунки и все таблицы нумеруются. 
  • Все рисунки и таблицы должны иметь надпись или подпись.  Они должны иметь содержательные подписи. Например, рисунок, на котором изображен график, следует подписывать не "График", но, например, "Переходная функция". Перед подписью должны стоять "Рис. 3. ..." или "Табл. 3. " или "Рис. 3.1. ..." или "Табл. 4.3. ...". Рисунок и таблица (в отличие от формул) не могут быть частью никакого предложения.
  • Формулы могут находиться только внутри предложений или таблиц. Но каждый рисунок и каждую таблицу нужно хоть раз упомянуть в тексте. Все (!) формулы, данные отдельной строкой, -- обязательно нумеруются числом в скобках на правом краю строки.
    В формулах надо следить за соответствием размерностей. Часть размерную нельзя приравнивать к безразмерной.
    Неверно будет "I = U/R = 4/2 = 2 A", но
    верно "I = U/R = 4 В / 2 Ом = 2 A". Впрочем, арифметические вычисления в большинстве случаев рекомендуется оставлять в черновиках.
  • Для обозначения единиц измерения следует использовать только стандартные сокращения. За исключением надстрочных символов (градус, угловые секунда и минута)  их обязательно отделять от числа пробелом. Недопустимо употреблять сокращения единиц без предшествующего числа (например, "несколько кг").
  • Однозначные числа, не описывающие физические величины, следуют писать прописью: "два человека", "пять резисторов", но не "2 человека", "5 резисторов". 
  • На графике, либо в его подписи должны быть указаны величины на координатных осях, а если оси оцифрованы, то и единицы измерения.
  • Недопустим плагиат. То есть включение фрагментов текстов и изображений из других источников без ссылок на них! Источники обычно перечисляются нумерованным списком в конце работы. Не рекомендуется ссылаться на неопубликованные документы и сомнительные сайты, авторство которых неизвестно. 
  • На каждый рисунок, таблицу и источники информации должно быть хоть по одной ссылке в тексте. Причем ссылка должна предшествовать объекту ссылки.  Ссылки  на формулы записываются числом в круглых скобках, на источники — в квадратных скобках.
Категория: Справочные материалы | Добавил: Козлов (27-Ноя-2011)
Просмотров: 344