Рекомендации по оформлению отчетов
Коротко изложены основные рекомендации по оформлению отчетов по лабораторным работам.
Общие положения
Отчет по каждой лабораторной работе представлен отдельным файлом.
Заголовок отчета включает название лабораторной работы, имена (или псевдонимы — например, в случае публикации отчета во Всемирной паутине) авторов, дату составления отчета.
В заголовке отчета по индивидуальной работе указывается единственный автор.
Для работ, выполняемых в малых группах, допускается оформление отчета в соавторстве.
Для каждого выполненного задания указан соответствующий номер пункта (подпункта.) Представлены достаточные свидетельства выполнения задания (выполненные команды, результат их работы, URI найденных или опубликованных материалов, etc.); сделан вывод.
Текст должен не оставлять сомнений в понимании автором смысла задания и полученных результатов. Вероятно, для этого потребуется примерно 10 ÷ 250 слов текста на каждый балл.
Файлы крайне желательно размещать на HTTP-сервере (например,
http:
.) Файлы малого объема (до 64 КиБ в сумме) допустимо передавать электронной почтой. (См. также §189 «Ководства».)//transfer .sh/
Допустимые форматы файлов
Для отчета предлагается использовать один из следующих открытых форматов. Все файлы должны соответствовать применимым техническим стандартам и позволять выполнять поиск по тексту документа.
Не следует применять «фирменные» форматы файлов, поскольку они как правило могут быть прочитаны только лишь «фирменными» же программами.
ИСО 32000-1:2008 (PDF.)
HTML — синтаксически и семантически корректный.
Обратите внимание на то, что документ должен не только корректно воспроизводится соответствующим программным обеспечением, но и успешно проходить формальную проверку с использованием
http:
и (или) иных подобных средств. Элементы и атрибуты HTML должны быть использованы семантически-обоснованно — сообразно смыслу, которым их наделяет текущая практика и актуальные спецификации.//html5 .validator .nu/ Для оформления допустимо применить CSS, а равно (прежде всего — для формул и графиков) MathML, SVG и JavaScript. При этом, документ должен оставаться читаемым в случае отказа пользовательского агента в поддержке каких-либо из этих компонент, или даже их всех. (Как, например, при использовании расширения uMatrix для Chromium и Firefox; или же какого-либо из «легковесных» пользовательских агентов Всемирной паутины — Lynx, Dillo, Edbrowse, etc.)
«Просто текст» — последовательность символов в коде на основе ASCII (ИСО/МЭК 646; например — UTF-8); из управляющих кодов используются лишь CR и LF (разрыв строки), HT, FF.
В этом формате, абзацы разделяются пустой строкой.
Для форматов HTML и «просто текст» изображения должны быть представлены отдельными графическими файлами (SVG, PNG, JFIF/.jpeg
), с включением в документ ссылок (URI) на эти файлы. Изображения малого объема (сотни байт) допустимо включить в документ HTML как URI схемы data:
.
Во всех случаях текст должен следовать принятым типографским соглашениям (в частности, использовать «правильные» кавычки — и тире. См. также §§97, 104 «Ководства».)
Отчет может быть размещен во Всемирной паутине (или же на «местном» HTTP-сервере) отдельным ресурсом (подобно: http:
), или же как содержащий все файлы отчета файл-архив одного из следующих открытых форматов:
Пример
Пример отчета, оформленного как «просто текст.»
Завоевание мира Отчет по лабораторной работе Брейн, Пинки 1.1 Выполнили команду $ time conquer world. Через 47 мин после запуска команды канал World Weakly News сообщил о завоевании одной небольшой страны. Полностью завоевать мир не удалось — предположительно из-за недостаточности ресурсов имеющейся в нашем распоряжении серверной операционной системы. (Диагностическое сообщение, выданное conquer, соответствует системной ошибке ENOINVADE.)