Части Техотчётов

Материал из Брацка Правки
Перейти к: навигация, поиск

Части Техотчётов (здесь и далее по тексту -- Лектио) -- это часть урока Суть Техотчётов. В Брацкой Школе, уроки делятся на так называемые лектио, каждое из которых состоит из микролекции и одного или нескольких заключительных вопросов. Урок, в свою очередь, относится к практическому семинару Выбор Профессии.


Материалы

Предшественник этого Лектио -- Что Есть Техотчёт.

Иллюстрации


Текст (HTML)

Части Техотчётов

Быстрота распространения технических отчётов важнее стилистики и читабельности. Потому технические отчёты могут быть продуктами проектов в разработке.

Отчёты состоят из вступительного, содержимого и вспомогательного материала. Их технические собратья включают что-то из тех же частей.

Вступительная часть включает все материалы, предшествующие основному содержанию. Она обеспечивает:

  1. Общее представление о цели и объёме отчета,
  2. Справочную информацию или контекст для отчёта, и
  3. Оглавление или содержание, а также списки для поиска определённых разделов, рисунков и таблиц.

Основное содержание -- это часть отчёта, в которой описываются методы, предположения и процедуры, затем представляются и обсуждаются результаты, делаются выводы и рекомендуются действия, основанные на этих результатах. Структура отчёта -- целевая и зависит от его темы и аудитории, а также от цели. Одной из типичных последовательностей является "Обобщение-Ситуация-Задачи-Действия-Результаты-Обсуждения".

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

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

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

На Брацком Облаке, Брацка Правка служит инструментом работы с отчётами. Технический отчёт там -- это вики-страница принадлежащая категории Категория: Технические Отчёты. Когда технический отчёт проверен редактором или другим ответственным лицом, технический отчёт становится просто отчётом и переводится в категорию Категория: Отчёты.

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

Варианты

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

Термины

Отчёт, Техотчёт

Экзамен

Определения

Вопросы экзамена

Любое описание, которое представляет мнения и предположения о продукте, также может рассматриваться как отчет. -- Правда\неправда