Части Техотчётов — различия между версиями

Материал из Брацка Правки
Перейти к: навигация, поиск
(Текст)
(Термины)
 
(не показаны 22 промежуточные версии 2 участников)
Строка 1: Строка 1:
[[Свойства Техотчётов]] (здесь и далее по тексту -- ''Лектио'') -- это часть урока [[Суть Техотчётов]]. В [[Брацка Школа|Брацкой Школе]], уроки делятся на так называемые [[лектио]], каждое из которых состоит из микролекции и одного или нескольких заключительных вопросов. Урок, в свою очередь, относится к практическому семинару '''[[Выбор Профессии]]'''.
+
[[Части Техотчётов]] (здесь и далее по тексту -- ''Лектио'') -- это часть урока [[Суть Техотчётов]]. В [[Брацка Школа|Брацкой Школе]], уроки делятся на так называемые [[лектио]], каждое из которых состоит из микролекции и одного или нескольких заключительных вопросов. Урок, в свою очередь, относится к практическому семинару '''[[Выбор Профессии]]'''.
  
  
Строка 9: Строка 9:
 
</gallery>
 
</gallery>
  
===Текст===
 
:<p><strong>Свойства Техотчётов</strong></p><p>Отчёты характеризуются несколькими свойствами. Своевременность, фактичность, полнота, адресность и удобство пользования -- это те пять свойств, которые особенно важны для технических отчётов.</p><p>Своевременность отчёта -- это свойство отправки отчёта так быстро, как требуется. Время отправки может требоваться либо получателем отчёта, либо отправителем, чтобы своевременно получить реакцию получателя на отчёт. В идеальном мире, отчёт должен появляться до того, как его данные необходимы получателю, а ответ на отчёт -- до того момента, когда реакция получателя отчёта нужна отправителю.</p><p>В реальной, нецифровой жизни практически невозможно предугадать, когда получатель воспользуется отчётом. Потому своевременность можно воспринять как "быстроту" и определение переформулировать в "настолько быстро, насколько возможно".</p><p>Фактичность свидетельствует о доле фактических данных о отчёте. Фактические отчёты основаны на чёткой проверенной информации; они представляют собой объективное изложение фактов. Наоборот, предвзятые отчёты основаны на мнениях, пристрастиях, предубеждениях и взглядах. Предвзятость может исходить либо из природы автора, либо желалания автора манипулировать потребителем отчёта.</p><p>Полнота отчета указывает на присутствие в отчёте необходимых атрибутов и отсутствия излишних. Полные отчёты предоставляют своим потребителям столько данных, сколько возможно и для конкретной целевой аудитории необходимо.</p><p>Адресность отражает обращение к конкретной целевой аудитории. Хорошо адресованные отчёты, например, разъяснят жаргон и ту терминологию, с которой аудитория не знакома.</p><p>Удобство пользователя (usability; в русском жаргоне -- "юзабилити") -- это практичность пользованием отчётом для пользователя. Заголовки, разбиение на разделы, названия разделов, длина предложений, количество причастных и деепричастных оборотов, наличие содержания разделов, краткого изложения содержимого отчёта и разъяснения терминов являются элементами удобства пользования.</p><p>Не все свойства созданы равными. Своевременность, фактичность и полнота отчёта более важны, чем адресность и удобство пользования.</p><p><i>А теперь, выберите, пожалуйста, лучшее завершение следующего предложения.</i> Судя по тексту выше, своевременность отчёта:</p>
 
  
<p>Технические отчёты предназначены для быстрого оповещения исследователей. Быстрота распространения отчётов важнее стилистики и читабельности. Отчёты преследуют различные цели. Они:<ol type="a"><li>Сообщают последние результаты и описывают ход исследований, тестировок, разработок или других проектов,</li><li>Служат справочной информацией по возникающей или важной теме,</li><li>Предоставляют список инструкций или процедур для текущей практики,</li><li>Оценивают применимость, осуществимость и целесообразность внедрения новой технологии и рекомендуют, следует ли продолжать исследования и как оценивать достигнутый прогресс,</li><li>Содержат подробные технические характеристики систем, функций, характеристик и работ.</li></ol></p><p>Отчёты часто представляют лишь временный снимок текущих исследований в определенной области или теме. Для достижения своих целей, они разделяют следующие характеристики:<ol type="a"><li>Содержимое не публикуется через издательства и обычные коммерческие каналы. Вместо этого отчёты и доклады обнародуются или спонсируются правительственными учреждениями, ассоциациями, обществами, советами, фондами, лабораториями, университетами, некоммерческими и коммерческими предприятиями.</li><li>Формат обеспечивает быстрое сообщение результатов новых исследований.</li><li>Отчеты рассылаются целевой аудитории напрямую. Они могут содержать специальные термины и могут быть рассчитаны на тех потребителей, которые разбираются в технической стороне вопроса.</li><li>Отчеты включают подробную методологию и данные.</li><li>Публикации обычно не рецензируются, но иногда являются результатом другого процесса отбора, например, прошли через конкурс, сделаны по контракту или выбраны для обнародования предприятием.</li><li>Корпоративное авторство обычно подчеркивается.</li></ol></p><p>Из-за своих целей и характеристик, технические отчёты обыкновенно оказываются сухими и излишне детализованными документами. Чтобы представить данные техотчётов клиентам и другим заинтересованным лицам, предприятия делают на основе технических отчётов доклады (white paper). Доклады -- это уже маркетинговые документы. Они написаны более простым языком, чем отчёты. Доклады могут также содержать заявительные утверждения, то есть, мнения в любом разделе. Технические отчеты, как правило, допускают мнения только в разделе "Истолкования".</p><p>Целевые аудитории отчётов и докладов пускай не полностью, но отличаются. Доклады могут использоваться для привлечения внимания к отчётам.</p>
+
===Текст (HTML)===
 +
:<p><strong>Части Техотчётов</strong></p><p>Быстрота распространения технических отчётов важнее стилистики и читабельности. Потому технические отчёты могут быть продуктами проектов в разработке.</p><p>Отчёты состоят из вступительного, содержимого и вспомогательного материала. Их технические собратья включают что-то из тех же частей.</p><p>Вступительная часть включает все материалы, предшествующие основному содержанию. Она обеспечивает:<ol type="a"><li>Общее представление о цели и объёме отчета,</li><li>Справочную информацию или контекст для отчёта, и</li><li>Оглавление или содержание, а также списки для поиска определённых разделов, рисунков и таблиц.</li></ol></p><p>Основное содержание -- это часть отчёта, в которой описываются методы, предположения и процедуры, затем представляются и обсуждаются результаты, делаются выводы и рекомендуются действия, основанные на этих результатах. Структура отчёта -- целевая и зависит от его темы и аудитории, а также от цели. Одной из типичных последовательностей является "Обобщение-Ситуация-Задачи-Действия-Результаты-Обсуждения".</p><p>Вспомогательные материалы дополняют и поясняют основное содержание отчёта (например, приложения), упрощают использование основной части (например, список терминов, списки символов, сокращений и акронимов, указатель) и показывают, где можно найти дополнительную информацию (например, библиография).</p><p>Как и любые иные документы, технические отчеты состоят из основного содержимого и метаданных. Помимо заголовка, даты, авторов, владельцев и других обычных атрибутов, метаданные отчётов регулярно включают индексы для удобства поиска. Обыкновенно, индексы представляют собой инвентарные или идентификационные коды, серии отчётов и номера контрактов. Индексы отчётов государственных органов, как правило, включают идентификатор финансирующего органа и организации, выполняющей исследование.</p><p>Технические отчёты часто представляют лишь временный снимок текущих тестировок, разработок, проектов и исследований  в определенной области или теме. Временные снимки заменяются постоянным, когда публикуется основной отчёт.</p><p>На Брацком Облаке, Брацка Правка служит инструментом работы с отчётами. Технический отчёт там -- это вики-страница принадлежащая категории [[:Категория: Технические Отчёты]]. Когда технический отчёт проверен редактором или другим ответственным лицом, технический отчёт становится просто отчётом и переводится в категорию [[:Категория: Отчёты]].</p><p><i>А теперь, выберите, пожалуйста, лучшее завершение следующего предложения.</i> Судя по тексту выше, технический отчёт может быть определён как:</p>
  
 
===Варианты===
 
===Варианты===
:
+
:предварительный отчёт. / отчёт состоящий из вступительного, содержимого и вспомогательного материала. / отчёт включающий основное содержимое в разработке и метаданные. / временный снимок текущих тестировок, разработок, проектов и исследований  в определенной области или теме.
  
:Следующее лектио -- '''[[Структура Техотчётов]]'''
+
:Следующее лектио -- '''[[Содержимое Техотчётов]]'''
  
 
===Термины===
 
===Термины===
:[[Отчет]]
+
:[[Отчёт]], [[Техотчёт]]
  
 
==Экзамен==
 
==Экзамен==

Текущая версия на 16:34, 21 сентября 2022

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


Материалы

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

Иллюстрации


Текст (HTML)

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

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

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

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

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

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

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

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

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

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

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

Варианты

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

Термины

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

Экзамен

Определения

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

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