Рекомендации по оформлению отчетов

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

Общий план

При составлении отчетов предлагается следовать нижеприведенному общему плану.

  1. Сформулируйте решаемую задачу. Какие данные являются исходными, какие подлежат получению? Какую структуру имеют входной и выходной потоки данных? Каким образом (с использованием каких формул, алгоритмов) в работе результирующие данные вычислены из исходных?

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

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

  2. Приведите реализованный алгоритм — в виде перечня шагов, блок-схемы или (и) диаграммы потока данных.

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

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

  3. Представьте результаты проверки правильности работы кода — сравнения результатов работы кода с какими-либо «эталонными» (проверочными) значениями. Приведите соответствующие графики и (если объем данных — невелик) таблицы. Вычислите статистики для отклонения полученных результатов от идеальных; сравните их с предсказанными для используемого метода.

    Если используемый метод позволяет найти оценку погрешности результата — определите, попадает ли истинное значение величины в найденный доверительный интервал.

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

    Если известны — перечислите возможные пути улучшения результатов.

  5. Перечислите источники, на которые сделаны ссылки в отчете.

  6. В приложении — приведите ссылку (URI) на находящуюся в открытом доступе копию программного кода (или собственно саму копию кода), проверочные наборы данных, и т. д. При необходимости — включите любые иные замечания и объяснения, касающиеся работы или отчета.

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

Представление отчета в электронном виде

Для электронной копии отчета предлагается использовать один из следующих открытых форматов. Электронная копия должна соответствовать применимым техническим стандартам, иметь умеренный объем (не более порядка 64 КиБ на страницу ИСО A4), и позволять выполнять поиск по тексту документа.

Для форматов HTML5 и «просто текст» допустимо вынесение графиков в отдельные графические файлы (SVG, PNG), с включением в документ ссылок (URI) на эти файлы.

Отчет может быть размещен во Всемирной паутине как «страница» (например: http://example.com/), или же как содержащий все файлы отчета файл-архив одного из следующих открытых форматов: