Uncategorized

Рекомендации к оформлению технического журнала

Технический журнал команды (или инженерная книга), разработавшей мобильного робота для решения поставленной задачи, с одной стороны является дневником процесса проектирования и реализации изделия, а с другой стороны представляет собой комплект документации, который описывает устройство и принцип работы всей системы.

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

Приведенное в статье не является официальной позицией организаторов и может не соответствовать конкретному регламенту конкретных соревнований, т.к. является личным, субъективным мнением автора.

Статья дополняется

Общие рекомендации по оформлению

Оформленная согласно стандартам документация упрощает её изучение и сокращает время на её прочтение за счет соблюдения определенной структуры подачи материала. Например, плавный переход документации от общего к частному позволит любому человеку, не знающему предыстории разработки продукта, быстро разобраться в содержимом. В случае с оценкой технических журналов, подготовленными студентами, жюри, как правило, имеет сильно ограниченные временные рамки на вынесение оценки, поэтому очевидная и ожидаемая структура подачи материала существенно облегчает процесс изучения документа.

Ниже приведены некоторые типичные ошибки, которые допускают студенты при оформлении своих инженерных книг:

  • Рисунок без подписи
  • Структурная схема или блок-схема без описания
  • Использование личных местоимений (разговорный стиль)

В самом тексте обязательно должна быть явная ссылка на рисунок (например, «Как показано на рисунке 3, встроенный дефект конструкции не позволял…») подробно раскрывающий то, что проиллюстрировано на изображении. Желательно, чтобы ссылка на рисунок была до самого рисунка, но на этой же или соседней странице.

Приведенные в документе структурные или иные схемы должны быть описаны, чтобы пояснить каждый компонент и характер взаимосвязи между компонентами были очевидны читающему данный материал.

Рекомендуется использовать менее эмоциональный и более научный стиль подачи материала. Например, вместо «мы пришли к выводу» лучше использовать «был сделан вывод».

Описание конструкции изделия

Кроме того, что в журнале оценивается качество и полнота документации, оценивается и само конструктивное решение.

При оценке итоговой конструкции мобильного робота обращается внимание на то, собрана ли она с учетом промышленных стандартов и то, насколько прочной получилась конструкция. Самой низкой оценки заслуживает та конструкция, которая позволяет перемещаться тем узлам, которые должны быть зафиксированы, а также там, где используется излишнее количество деталей.

В рамках документации по разработанной конструкции обычно ожидается увидеть общие габаритные размеры, указание посадочных отверстий, технические характеристики и предназначение входящих в неё узлов. Также хорошим тоном считается продуманные возможности по обслуживанию и эксплуатации конструкции.

Часто приходилось снижать оценку за оформление описания конструкции за то, что приводились изображения низкого качества (реализованных, по-видимому, в PowerPoint или Paint), не принятые к использованию в отрасли, хотя ожидалось увидеть что-либо более близкое к тому, как это принято в отрасли. В качестве хорошего примера можно привести то, как внешний вид и основные элементы описаны в роботе-пылесосе на рисунке 1 или как показаны габаритные размеры мобильного робота для использования в открытой местности на рисунке 2.

Рисунок 1 — Пример оформления описания конструкции/внешнего вида мобильного робота (источник)
Рисунок 2 — Пример оформления габаритных размеров мобильного робота (источник)

Описание электрической схемы и монтажа

В первую очередь ожидается увидеть общую электрическую схему, описывающую основные элементы и соединения между ними, затем более подробно показать на отдельных схемах подробности, которые были опущены в общей схеме. Далее возможно продемонстрировать качество выполненного электрического монтажа.

Первое, на что можно обратить внимание при проверке качества монтажа, это качество прокладки электрического провода. В рамках этого можно рассмотреть то, насколько кабель или кабельная сборка (несколько кабелей вместе) зафиксированы от возможного движения, например, если кабель зафиксирован через каждый определенный промежуток расстояния и не имеет возможности перемещения.

Описание программного обеспечения

Начинать документацию программы необходимо с приведения общих сведений и функционального назначения. Далее нужно дать описание логической структуры программного обеспечения. После этого входящие подпрограммы необходимо описать с точки зрения того, какие входные данные они имеют, какие преобразования выполняются над входными данными внутри подпрограммы и какие выходные данные выдаются.

Стандарты

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

Ниже приведены некоторые из них, которые могут оказаться полезными при составлении документации на изделие:

  1. ГОСТ Р 1.0-2004 Стандартизация в Российской Федерации. Основные положения
  2. ГОСТ 8.417-2002 Государственная система обеспечения единства измерений (ГСИ). Единицы величин
  3. ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам
  4. ГОСТ 2.103-68 Единая система конструкторской документации (ЕСКД). Стадии разработки
  5. ГОСТ 23592-96. Монтаж электрический радиоэлектронной аппаратуры и приборов. Общие требования к объемному монтажу изделий электронной техники и электротехнических
  6. ГОСТ 19.402-78 ЕСПД. Описание программы

Ответы

  1. Хорошие рекомендации, спасибо.
    Я бы также хотел поделиться своими рекомендациями к оформлению тех журнала, прикреплю файлом.
    Ссылка на файл: https://is.gd/pG5QFe

Обсудите на talk.roboticsclub.ru

Участники обсуждения