Документирование схемы и результатов
Цель: Научиться оформлять схему и результаты моделирования так, чтобы другой человек мог понять условия расчёта, повторить эксперимент и проверить вывод.
3 часа короткая теория, самостоятельная практика, проверка результата и тест.
Суть темы
Документирование — часть эксперимента. Одного снимка графика недостаточно: без схемы, номиналов, вида анализа и условий невозможно понять, что именно было рассчитано. В практикуме ИТМО отчёт рассматривается как самодостаточный документ.
Хорошая запись связывает исходную схему, ожидаемый результат, настройки расчёта, полученный график или таблицу и вывод. Если модель менялась, должна быть понятна актуальная версия.
Ключевые связи и параметры
На схеме должны быть читаемы обозначения элементов, значения и контрольные точки. На временном графике указывают оси, единицы и названия сигналов. Для частотной характеристики — частоту и измеряемую величину. Результат без единиц не является полноценным измерительным выводом.
В выводе не пересказывают действия, а отвечают на поставленный вопрос: совпал ли результат с расчётом, где есть отличие и чем оно объясняется.
Разбор примера
Запись «усилитель работает, график нормальный» не позволяет повторить исследование. Нормальная запись содержит схему каскада, напряжение питания, параметры входного сигнала, измеренные амплитуды, рассчитанный коэффициент усиления и указание диапазона, где возникло ограничение.
Практическая работа и проверка
- Сохраните актуальную схему.
- Подпишите контрольные точки.
- Запишите вид анализа и его параметры.
- Добавьте график или таблицу с единицами.
- Сформулируйте вывод в двух-трёх предложениях.
- Проверьте, сможет ли другой человек повторить расчёт.
Типичные ошибки и диагностика
- Вставлять график без схемы и условий.
- Не указывать единицы.
- Смешивать результаты разных версий схемы.
- Подменять вывод описанием нажатых кнопок программы.
Связь с реальным устройством
Такая документация облегчает переход к физическому макету: заранее известны контрольные точки, ожидаемые значения и условия, которые нужно воспроизвести измерительными приборами.
Что нужно запомнить
- Отчёт должен быть самодостаточным.
- Схема, условия расчёта и результат должны относиться к одной версии.
- Графики требуют подписанных осей и единиц.
- Вывод отвечает на инженерный вопрос, а не перечисляет действия.
- Документация должна позволять повторить эксперимент.