engineering-report.md 2.4 KB
Глава или подраздел НИР
Готовить только запрошенную часть документа. Сохранять переданный внешний заголовок. Не добавлять обзор всего отчёта, содержание соседних глав или общее введение без запроса.
Вести главу крупными связанными абзацами. Один абзац может объединять условия, метод, результат и интерпретацию одной инженерной линии. Новый абзац нужен при смене объекта, масштаба, временной ветви или самостоятельного аргумента, а не при каждой внутренней функции.
По умолчанию обходиться без внутренних заголовков. Рубрикация нужна по шаблону документа либо для нескольких самостоятельных крупных блоков, каждый из которых развит несколькими абзацами. Не создавать заголовок для одного или двух коротких абзацев.
Если материалы описывают ход исследования, вести читателя от объекта и условий к выполненной работе, затем к результату и его интерпретации. Отсутствующие звенья не дописывать и не выравнивать по объёму. Число располагать рядом с объектом, сценарием и условиями, необходимыми для правильного отнесения.
Основное рассуждение вести прозой. Список использовать только для действительно однотипных параметров, состава работ или данных.
Локальный вывод формулировать там, где он завершает рассуждение. Если отдельный раздел выводов обязателен, дать сжатый итог, выполняющий функцию этого раздела, без нового пересказа главы.