Что Есть Техотчёт

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

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


Материалы

Предшественник этого Лектио -- Указание Источников.

Иллюстрации

Текст

Что Есть Техотчет

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

Как и любые иные документы, технические отчеты состоят из основного содержимого и метаданных. Метаданные отчёта включают заголовок, дату, авторов, владельцев и так далее.

Структура технического отчёта -- целевая. Рассмотрим последовательность "Обобщение-Ситуация-Задача-Действия-Результат-Истолкование":
  1. Обобщение (Summary) -- это сжатое изложение содержания отчёта. Это позволяет читателям решить, заинтересованы ли они в дальнейшем чтении. Этот раздел отчёта кратко отвечает на вопрос: "Что отчёт меняет?"
  2. Ситуация (Situation). Этот раздел описывает проблему, предысторию и ситуацию на момент начала проекта или исследования.
  3. Задача (Task) -- это задание на исследование или документ авторизующий проект.
  4. Действия (Undertaking). В этом разделе даны ответы на вопросы "Кто, где, когда и как проводил исследование?" Здесь описаны действия, методы, допущения и задействованные процедуры.
  5. Результат (Finding) описывает результаты исследования. Этот раздел отвечает на вопрос "Что было найдено?"
  6. Истолкование (Interpretation) описывает выводы, решения и последствия, которые могут быть следствием отчёта, а также обсуждения, которые, возможно, представляют разные точки зрения, и, если требуется, рекомендации относительно дальнейших действий. Этот раздел отвечает на вопрос: "Что авторы отчёта обсуждали о том, что результаты исследования меняют?"

Официальные документы можно определить, как те технические отчеты, которые были созданы для обучения клиентов продукта. Из-за своей маркетинговой цели эти статьи обычно написаны более простым языком, чем технические отчеты. "Белые Книги" могут также включать в себя высказывания мнений в любом разделе; технические отчеты, как правило, допускают мнения только в разделе интерпретации. Термин Белые книги в основном применяется в США и других странах Европы, его значение -- официальный письменный документ, не рекламного содержания, который объясняет и показывает как пользоваться, к примеру, программой.


В отличие от других документов, структура и атрибуты научных и технических отчётов регулируются стандартами. Один из таких стандартов утверждён Американским Национальным Институтом Стандартов (American National Standards Institute).

Термины

Техотчет, Белые книги, SSUFI, STAR

Вопрос(ы)

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