Перечень необходимых инструкций схем и других оперативных документов: 2.8. Техническая документация на тепловые энергоустановки

Содержание

2.8. Техническая документация на тепловые энергоустановки

Содержание
  • Техническая документация на тепловые энергоустановки
  • Литература

 Техническая документация на тепловые энергоустановки

2.8.1. При эксплуатации тепловых энергоустановок хранятся и используются в работе следующие документы:

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

2.8.2. В производственных службах устанавливаются перечни необходимых инструкций, схем и других оперативных документов, утвержденных техническим руководителем организации. Перечни документов пересматриваются не реже 1 раза в 3 года.

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

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

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

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

2.8.4. Все рабочие места снабжаются необходимыми инструкциями, составленными в соответствии с требованиями настоящих Правил, на основе заводских и проектных данных, типовых инструкций и других нормативно-технических документов, опыта эксплуатации и результатов испытаний оборудования, а также с учетом местных условий.

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

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

2.8.5. В должностных инструкциях персонала по каждому рабочему месту указываются:

  • перечень инструкций и другой нормативно-технической документации, схем установок, знание которых обязательно для работника;
  • права, обязанности и ответственность работника;
  • взаимоотношения работника с вышестоящим, подчиненным и другим связанным по работе персоналом.

2.8.6. В инструкциях по эксплуатации тепловой энергоустановки приводятся:

  • краткое техническое описание энергоустановки;
  • критерии и пределы безопасного состояния и режимов работы;
  • порядок подготовки к пуску, пуск, остановки во время эксплуатации и при устранении нарушений в работе;
  • порядок технического обслуживания;
  • порядок допуска к осмотру, ремонту и испытаниям;
  • требования по безопасности труда, взрыво- и пожаробезопасности, специфические для данной энергоустановки.

По усмотрению технического руководителя инструкции могут быть дополнены.

2.8.7. Инструкции пересматриваются и переутверждаются не реже 1 раза в 2 года. В случае изменения состояния или условий эксплуатации энергоустановки соответствующие дополнения и изменения вносятся в инструкции и доводятся записью в журнале распоряжений или иным способом до сведения всех работников, для которых знание этих инструкций обязательно.

2.8.8. Управленческий персонал в соответствии с установленными графиками осмотров и обходов оборудования проверяет оперативную документацию и принимает необходимые меры к устранению дефектов и нарушений в работе оборудования и персонала.

2.8.9. Оперативный персонал ведет оперативную документацию, примерный перечень которой приведен в приложении №4. В зависимости от местных условий перечень оперативных документов может быть изменен решением технического руководителя. Решение оформляется в виде утвержденного руководством предприятия перечня оперативных документов, включающего наименование документа и краткое его содержание.

 Литература

  1. Правила технической эксплуатации тепловых энергоустовок
  2. Теплоэнергетические установки: сборник нормативных документов. – М.: ЭНАС, 2013. – 384 с.
  3. Правила технической эксплуатации тепловых энергоустовок. – СПб.: ЦОТПБСП, 2004. – 224 с.

Эксплуатация тепловых пунктов. Полный перечень необходимых документов

Полный перечень документов необходимых при эксплуатации тепловых пунктов.

Уважаемые Господа,

Компания ЭССИ предлагает воспользоваться квалифицированными услугами по Обслуживанию тепловых пунктов.

При эксплуатации тепловых пунктов, ведутся следующие документы:

1. При эксплуатации тепловых энергоустановок хранятся и используются в работе следующие документы:

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

2. В производственных службах устанавливаются перечни необходимых инструкций, схем и других оперативных документов, утвержденных техническим руководителем организации. Перечни документов пересматриваются не реже 1 раза в 3 года.

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

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

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

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

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

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

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

5. В должностных инструкциях персонала по каждому рабочему месту указываются:

  • перечень инструкций и другой нормативно-технической документации, схем установок, знание которых обязательно для работника;
  • права, обязанности и ответственность работника.
  • взаимоотношения работника с вышестоящим, подчиненным и другим связанным по работе персоналом.

6. В инструкциях по эксплуатации тепловой энергоустановки приводятся:

  • краткое техническое описание энергоустановки;
  • критерии и пределы безопасного состояния и режимов работы;
  • порядок подготовки к пуску, пуск, остановки во время эксплуатации и при устранении нарушений в работе;
  • порядок технического обслуживания;
  • порядок допуска к осмотру, ремонту и испытаниям;
  • требования по безопасности труда, взрыво- и пожаробезопасности, специфические для данной энергоустановки. По усмотрению технического руководителя инструкции могут быть дополнены.

7. Инструкции пересматриваются и переутверждаются не реже 1 раза в 2 года. В случае изменения состояния или условий эксплуатации энергоустановки соответствующие дополнения и изменения вносятся в инструкции и доводятся записью в журнале распоряжений или иным способом до сведения всех работников, для которых знание этих инструкций обязательно.

8. Управленческий персонал в соответствии с установленными графиками осмотров и обходов оборудования проверяет оперативную документацию и принимает необходимые меры к устранению дефектов и нарушений в работе оборудования и персонала.

9. Оперативный персонал ведет оперативную документацию, примерный перечень которой приведен в приложении №4. В зависимости от местных условий перечень оперативных документов может быть изменен решением технического руководителя. Решение оформляется в виде утвержденного руководством предприятия перечня оперативных документов, включающего наименование документа и краткое его содержание.

Приложение №4 правил эксплуатации тепловых энергоустановок. Примерный перечень эксплуатационной документации























Наименование

Содержание

Оперативный журнал

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

Оперативная схема тепловых сетей (водяных, паровых, конденсатных)

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

Оперативная схема тепловых энергоустановок

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

Оперативная схема источника теплоты

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

Перечень камер и каналов, подверженных опасности проникновения газа

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

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

Наименование и краткие технические характеристики оборудования, находящегося в оперативном управлении и оперативном ведении диспетчера

Программа переключения

Запись о содержании операций и их перечень, времени начала и окончания, условиях проведения; сведения о персонале, выполняющем переключения, указания о последовательности переключений, положении запорной и регулирующей арматуры после их окончания; должность работника, контролирующего ход переключений и несущего за них ответственность

Схемы тепловых камер (насосных станций, тепловых пунктов)

Схема тепловой камеры (насосной станции, теплового пункта) с установленным в ней оборудованием, трубопроводами, арматурой и контрольно-измерительными приборами

Журнал обходов тепловых сетей

Запись заданий обходчиком тепловых сетей и результатов обхода

Журнал распоряжений

Запись распоряжений руководства организации, руководящего персонала энергослужбы

Журнал учета работ по нарядам и распоряжениям

В соответствии с правилами техники безопасности при эксплуатации тепломеханического оборудования электростанций, тепловых сетей и теплопотребляющих установок

Журнал заявок на вывод оборудования из работы

Регистрация заявок на вывод оборудования из работы от цехов (участков) с указанием наименования оборудования, причины и времени вывода его из работы (подачи заявки), а также объема теплопотребления отключаемого оборудования

Журнал дефектов и неполадок с оборудованием

Запись о неисправностях тепловых энергоустановок и тепловых сетей. Указываются дата записи, характер неисправности и ее принадлежность. Запись ответственного за исправное состояние и безопасную эксплуатацию тепловых энергоустановок об ознакомлении и устранении дефектов

Температурный график центрального регулирования системы теплоснабжения

График зависимости температур сетевой воды в подающих и обратных трубопроводах тепловой сети от температуры наружного воздуха

Пьезометрические графики

Давление в подающем и обратном трубопроводах по длине тепловой сети в зависимости от рельефа местности, для зимнего, летнего и аварийных режимов

Режимная карта

Документ, содержащий перечень оптимальных значений параметров для достижения надежной и экономичной эксплуатации тепловых энергоустановок, составленный по результатам режимно-наладочных испытаний

График ограничений и отключений

Документ, содержащий очередность ограничений и отключений потребителей при недостатке тепловой мощности или топлива, а также в случае аварии в энергоснабжающей организации

Журнал учета проведения противоаварийных и противопожарных тренировок

Журнал с указанием даты проведения тренировок, фамилий участников и должности, темы и места проведения, оценки и замечаний, подписей участников, подписи руководителя тренировки

Журнал учета состояния контрольно-измерительных приборов и автоматики

Записи о проводимых ремонтах, проверках работоспособности и поверках контрольно-измерительных приборов и автоматики

Журнал учета качества питательной, подпиточной, сетевой воды, пара и конденсата

Запись о качестве воды, пара и конденсата на основании химического контроля

Ведомости учета суточного отпуска тепловой энергии и теплоносителя на источнике теплоты

Запись о ежесуточных температуре, давлении, количестве отпущенного и возвращенного теплоносителя, расходе подпиточной воды, температуре холодной воды, количестве выработанной, потребленной на собственные нужды и отпущенной тепловой энергии по показаниям приборов учета тепловой энергии и теплоносителя

Журнал учета тепловой энергии и теплоносителя в водяных (паровых) системах теплопотребления

Запись о ежесуточных расходах теплоносителя по подающему, обратному, подпиточному трубопроводах (паропроводу, конденсатопроводу), трубопроводу системы горячего водоснабжения, величине тепловой энергии и времени работы приборов учета тепловой энергии

Ведутся при эксплуатации теплового пункта:











Наименование

Содержание

Оперативный журнал

Ведется обслуживающей организацией, в случае отсутствия заводится (обслуживающей организацией)

Журнал распоряжений

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

Журнал учета работ по нарядам и распоряжениям

Ведется заказчиком

Журнал заявок на вывод оборудования из работы

Ведется заказчиком

Журнал дефектов и неполадок с оборудованием

Ведется обслуживающей организацией, в случае отсутствия заводится (обслуживающей организацией)

Журнал учета проведения противоаварийных и противопожарных тренировок

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

Журнал учета состояния контрольно-измерительных приборов и автоматики

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

Журнал учета качества питательной, подпиточной, сетевой воды, пара и конденсата

Ведется на котельных, ТЭЦ и тд.

Ведомости учета суточного отпуска тепловой энергии и теплоносителя на источнике теплоты

Не обязательный документ

Журнал учета тепловой энергии и теплоносителя в водяных (паровых) системах теплопотребления

Ведется обслуживающей организацией, в случае отсутствия заводится (обслуживающей организацией)

Документация, разрабатываемая при проектировании тепловых пунктов:


Наименование

Содержание

Проект теплового пунтка

Данный документ разрабатывается согласно требованиям и условиям подключения, выставляемыми такими инстанциями, как  «МОЭК», ФГУ Ростехнадзор, ОАО «Московская Теплосетевая Компания».

Проект теплового пункта состоит из:








Наименование

Содержание

Паспорт теплового пункта

Общие сведения о тепловом пункте

Принципиальные схемы проектируемого объекта (проектная и исполнительная документация)

Тепловая, схема автоматизации, электрическая

Схемы расположения оборудования

 

Спецификации оборудования

 

Сертификаты на поставляемое оборудование

 

Паспорта на готовые узлы и механизмы, входящие в состав теплового пункта

 

Пояснительные записки, прилагаемые к проектной и исполнительной документации

Гидравлические расчеты, установки контрольно измерительных приборов, принцип действия автоматики

При эксплуатации теплового пункта опираются на правила эксплуатации тепловых энергоустановок и инструкции по эксплуатации оборудования.

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

При эксплуатации теплового пункта указанные выше документы ведутся в соответствии с правилами технической эксплуатации тепловых энергоустановок.

При эксплуатации тепловых энергоустановок основными регламентирующими документами являются, Правила эксплуатации тепловых энергоустановок, предписания энергоснабжающих организаций.

Другие услуги компании ЭССИ ( ESSE)

  • Техническое обслуживание систем порошкового пожаротушения
  • Модернизация систем вентиляции и кондиционирования
  • Ремонт систем кондиционирования

С уважением и наилучшими пожеланиями Вам и Вашему бизнесу.


Коллектив компании «ЭССИ»

Организация ваших данных | Управление исследовательскими данными

Как только вы создаете, собираете или начинаете манипулировать данными и файлами, они могут быстро стать неорганизованными. Чтобы сэкономить время и предотвратить ошибки в дальнейшем, вы и ваши коллеги должны решить, как вы будете называть и структурировать файлы и папки. Включение документации (или «метаданных») позволит вам добавить контекст к вашим данным, чтобы вы и другие могли понять их в краткосрочной, среднесрочной и долгосрочной перспективе.

Ниже приведены некоторые рекомендации по:

  • Именование и организация файлов
  • Документация и метаданные
  • Управление ссылками
  • Организация электронной почты

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

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

 

Как организовать файлы?

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

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

  • Будьте последовательны  — при разработке схемы именования папок важно, чтобы после того, как вы определились с методом, вы придерживались его. Если можете, постарайтесь согласовать схему именования с самого начала вашего исследовательского проекта
  • Иерархическая структура папок — начните с ограниченного количества папок для более широких тем, а затем создайте более конкретные папки внутри этих
  • Разделяйте текущую и завершенную работу . Поскольку вы начинаете создавать множество папок и файлов, рекомендуется подумать о том, чтобы отделить ваши старые документы от тех, над которыми вы сейчас работаете
  • Старайтесь сохранить папку «Мои документы» для файлов, над которыми вы активно работаете и примерно раз в месяц перемещайте файлы, над которыми вы больше не работаете, в другую папку или место, например, в папку на рабочем столе, в специальную архивную папку или на внешний жесткий диск
  • Резервное копирование — убедитесь, что ваши файлы, независимо от того, находятся ли они на вашем локальном диске или на сетевом диске, заархивированы
  • Просматривайте записи — регулярно или в конце проекта оценивайте материалы, чтобы убедиться, что файлы не хранятся без необходимости. Поставьте напоминание в календаре, чтобы не забыть!

 

Что нужно учитывать при создании имени файла?

Примите решение об именовании файлов в начале проекта.

Полезные имена файлов: 

  • совместимые
  • значимо для вас и ваших коллег
  • позволяют легко найти файл.

Полезно, если ваш отдел/проект согласует следующие элементы имени файла:

  • Словарь – выберите стандартный словарь для имен файлов, чтобы все использовали общий язык
  • Пунктуация – принять решение о том, следует ли и когда использовать знаки пунктуации, заглавные буквы, дефисы и пробелы
  • Даты – договоритесь о логическом использовании дат, чтобы они отображались в хронологическом порядке, т.е. ГГГГ-ММ-ДД
  • Заказ — подтвердите, какой элемент должен идти первым, чтобы файлы на одну и ту же тему были перечислены вместе и поэтому их можно было легко найти
  • Номера — укажите количество цифр, которые будут использоваться в нумерации, чтобы файлы были перечислены в числовом виде, например. 01, 002 и т. д.

 

Как назвать файлы, чтобы знать, какой документ является самой последней версией?

Очень немногие документы составляются одним человеком за один присест. Чаще всего в процессе участвуют несколько человек, и это происходит в течение длительного периода времени. Без надлежащего контроля это может быстро привести к путанице в отношении того, какая версия является самой последней. Вот один из способов избежать этого:

  • Используйте систему нумерации «редакций». Любые серьезные изменения в файле могут быть указаны целыми числами, например, v01 будет первой версией, v02 — второй версией. Незначительные изменения могут быть обозначены увеличением десятичной цифры, например, v01_01 указывает на незначительное изменение, внесенное в первую версию, а v03_01 — на незначительное изменение, внесенное в третью версию.
  • Когда проекты документов направляются для внесения поправок, по возвращении они должны содержать дополнительную информацию для идентификации лица, внесшего поправки . Пример: файл с именем datav01_20130816_SJ указывает, что коллега (SJ) внес поправки в первую версию 16 августа 2013 года. Затем ведущий автор добавит эти поправки в версию v01 и переименует файл в соответствии с системой нумерации редакций.
  • Включите ‘ таблицу управления версиями ‘ для каждого важного документа, отмечая изменения и их даты вместе с соответствующим номером версии документа. Если это полезно, вы можете включить сами имена файлов вместе с номером версии (или вместо него).
  • Согласитесь, кто завершит финал и отметит их как «финал».

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


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

 

Что такое «документация» и «метаданные»?

Термин «документация» включает в себя всю информацию, необходимую для интерпретации, понимания и использования данного набора данных или набора документов. На этом веб-сайте мы используем термины «документация» и «метаданные» (данные о данных — обычно встроенные в сами файлы данных/документы) взаимозаменяемо.

 

Когда и как включать документацию/метаданные?

Рекомендуется начинать документировать свои данные в самом начале исследовательского проекта и продолжать добавлять информацию по ходу проекта. Включите процедуры документирования в планирование данных.

Существует несколько способов добавления документации к вашим данным: 

Встроенная документация

Информация о файле или наборе данных может быть включена в сами данные или документ. Для наборов цифровых данных это означает, что документация может находиться в отдельных файлах (например, в текстовых файлах) или быть интегрирована в файл(ы) данных в качестве заголовка или в определенных местах файла. Примеры встроенной документации включают:

  • код, описания полей и меток
  • описательные заголовки или резюме
  • запись информации в функцию свойств документа файла (Microsoft)

Сопроводительная документация;

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

  • Рабочие документы или лабораторные журналы
  • Анкеты или руководства по проведению интервью
  • Заключительные отчеты по проекту и публикации
  • Метаданные каталога

Вспомогательная документация должна быть структурирована таким образом, чтобы ее можно было использовать для идентификации и поиска данных через веб-браузер или веб-каталог. Метаданные каталога обычно структурированы в соответствии с международным стандартом и связаны с данными репозиториями или центрами обработки данных при депонировании материалов. Примеры данных каталога :

  • Название
  • Описание
  • Создатель
  • Фондер
  • Ключевые слова
  • Принадлежность

Цифровой кураторский центр предоставляет примеры метаданных по конкретным дисциплинам, которые можно просмотреть здесь.

 

Инструменты для отслеживания метаданных и стандарты данных

Инструменты ISA — инструменты отслеживания метаданных для наук о жизни

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

Инструменты ISA, построенные на основе табличного формата общего назначения «Исследование» (контекст проекта), «Исследование» (единица исследования) и «Ассей» (аналитическое измерение), помогают предоставить подробное описание экспериментальных метаданных. (т. е. характеристики образца, технологии и типы измерений, взаимосвязь между образцом и данными), чтобы полученные данные и открытия были воспроизводимыми и пригодными для повторного использования.

FAIRsharing — портал взаимосвязанных данных, баз данных и политик для наук о жизни с возможностью поиска

FAIRsharing — это курируемый портал с возможностью поиска взаимосвязанных стандартов данных, баз данных и политик в области наук о жизни, окружающей среды и биомедицинских наук.


Проекты могут длиться месяцами или годами, и легко потерять информацию, из какого источника она поступила. Восстановить половину ваших цитат в схватке в конце проекта может быть проблемой! Ваше будущее «я» может не помнить всего, что кажется очевидным в настоящем, поэтому важно делать четкие заметки об источниках.

 

Что такое «программное обеспечение для управления ссылками»?

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

 

Кто может помочь мне со справочными соглашениями и форматами для моей академической дисциплины или конкретного проекта?

Библиотекарь вашего отдела сможет помочь вам выбрать правильный формат для справок и, вероятно, будет знать о некоторых полезных инструментах поиска и управления, которые вы раньше не использовали. Смело спрашивайте у него/нее совета.
Кроме того, ваш библиотекарь колледжа также является очень хорошим ресурсом и всегда готов помочь.
Найдите библиотекаря своего факультета и колледжа в Справочнике библиотек университета.


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

 

Зачем мне упорядочивать свою электронную почту?

Помимо очевидного разочарования и потраченного времени на поиск того электронного письма, которое вы помните, отправили кому-то в прошлом месяце, электронная почта все чаще используется для хранения важных документов и данных, часто с информацией, связанной с вложениями в самом электронном письме. Без надлежащего контроля они часто могут быть удалены по ошибке. Также важно помнить, что ваша рабочая электронная почта подпадает под действие Закона о защите данных 1998 г. и Закона о свободе информации 2000 г., поэтому ваши электронные письма потенциально открыты для проверки.

 

Каковы первые шаги по организации моей электронной почты?

Если ваша электронная почта вышла из-под контроля, вы можете предпринять ряд немедленных шагов, чтобы справиться с проблемой:

  • Архивируйте старые электронные письма . Если у вас есть сотни писем, отправленных более месяца назад, переместите их в новую папку под названием «Архив». Вы всегда можете вернуться к ним позже.
  • Теперь просмотрите оставшийся почтовый ящик электронная почта по электронной почте. Если письмо бесполезно, удалите его. Если нет, спросите себя: является ли он «активным» — есть ли какое-то конкретное действие, которое вам или кому-то еще нужно предпринять, или вы просто смутно думаете, что его стоит сохранить? Если второе, переместите его в архив.

 

Как обеспечить порядок в электронной почте?

Вот несколько общих советов, которые помогут сохранить порядок в вашей электронной почте в долгосрочной перспективе:

  • Удаляйте ненужные электронные письма. Регулярно (в идеале ежедневно) удаляйте из папки «Входящие» и отправленные сообщения любые тривиальные или старые сообщения.
  • Используйте папки для хранения сообщений. Создать структурированный каталог файлов по теме, деятельности или проекту.
  • Отдельные личные сообщения электронной почты. Создайте для них отдельную папку. В идеале вы не должны получать никаких личных писем на свою рабочую учетную запись электронной почты.
  • Ограничение использования вложений. Используйте альтернативные и более безопасные методы для обмена данными, где это возможно (варианты см. в разделе «Обмен данными»). Если используются вложения, используйте контроль версий и сохраняйте важные вложения в других местах, например на сетевом диске.

 

Форматирование текста в инструкциях — Microsoft Style Guide

Твиттер

LinkedIn

Фейсбук

Электронное письмо

  • Статья
  • 8 минут на чтение

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

См. также
Описание взаимодействия с пользовательским интерфейсом
Заглавные буквы
Форматирование общих текстовых элементов
Форматирование текстовых элементов разработчика

В документации и техническом содержимом

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

Элемент Конвенция Пример
Лезвия Не говори о лезвиях. Вместо этого опишите, что клиент должен сделать.
Если необходимо обратиться к блэйду по имени, используйте жирный шрифт для имени блэйда.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Не включайте слово лезвие , если оно не добавляет необходимой ясности.
Выберите конкретную операцию, чтобы просмотреть сведения об этой операции.
В веб-приложении укажите имя для своего сайта.
Перейдите к Журналы аудита , чтобы просмотреть события, произошедшие с подпиской.
В колонке Resource group выберите Summary .
Кнопки, флажки и другие параметры Избегайте разговоров об элементах пользовательского интерфейса. Вместо этого опишите, что клиент должен сделать.
Если вы должны сослаться на кнопку, флажок или другой параметр, используйте жирный шрифт для имени.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу. Если метка параметра заканчивается двоеточием или многоточием, не включайте этот знак пунктуации в инструкции.
Не включайте тип элемента пользовательского интерфейса, например кнопку или флажок , , если только он не добавляет необходимой ясности.
Выберите Сохранить как ( вместо Выберите Сохранить как… или нажмите кнопку Сохранить как ).
Выберите Разрешить разбиение строки на страницы .
Снимите флажок Match case .
Команды командной строки Жирный. Все в нижнем регистре. копия
Параметры командной строки (также известные как переключатели или флаги) Жирный. Напишите заглавными буквами то, как должна быть введена опция.
/Ав
Команды Используйте жирный шрифт для имен команд.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу. Если метка команды заканчивается двоеточием или многоточием, не включайте этот знак препинания в инструкции.
Не включайте слово в команду , если оно не добавляет необходимой ясности.
Перейдите к Инструменты и выберите Изменить язык .
В меню Design выберите Colors , а затем выберите цветовую схему.
Имена баз данных Жирный. Использование заглавных букв в именах баз данных различается. База данных WingtipToys
Имена устройств и портов Все в верхнем регистре. USB
Диалоговые окна В общем, не говорите о пользовательском интерфейсе. Вместо этого поговорите о том, что клиент должен сделать.
Когда вам нужно обратиться к элементу пользовательского интерфейса, используйте диалоговое окно . Не используйте всплывающее окно , диалоговое окно или диалоговое окно .
Если вы должны обратиться к диалоговому окну по имени, используйте жирный шрифт для его имени.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу. Если метка диалогового окна заканчивается двоеточием или многоточием, не включайте этот знак препинания в инструкции.
Выберите Загрузить , а затем выберите файл для загрузки.
В свойствах выберите Подробности , а затем выберите Удалить свойства и личную информацию .
В диалоговом окне Защитить документ снимите флажок Фигуры .
Сообщения об ошибках Заглавные буквы в предложении. При ссылке на них в тексте заключайте сообщения об ошибках в кавычки. Мы не можем найти сканер.
Хм… похоже, это неработающая ссылка.
Если вы видите сообщение об ошибке «Проверьте состояние сканера и повторите попытку», используйте Центр обновления Windows, чтобы проверить наличие последних версий драйверов для вашего устройства.
Атрибуты файла Все строчные. Чтобы убрать скрытый атрибут со всех файлов в папке….
Расширения имен файлов Все строчные. .mdb
.doc
Имена файлов (примеры, определяемые пользователем) Заглавные буквы. Можно использовать внутренние заглавные буквы в именах файлов для удобочитаемости. Используйте жирный шрифт для имен файлов в процедурах, если вы предлагаете клиенту выбрать, ввести или иным образом взаимодействовать с именем. Мои налоги за 2016 год
Мои налоги за 2016 год
Введите Мои налоги за 2016 год .
Имена папок и каталогов (примеры, определяемые пользователем) Заглавные буквы в предложении. Можно использовать внутренние заглавные буквы в именах папок и каталогов для удобочитаемости. В процедурах используйте жирный шрифт для имен, если вы предлагаете клиенту выбрать, ввести или иным образом взаимодействовать с именем. Отпуск и оплата больничного
Мои файлы\Бухгалтерия\Зарплата\VacPay
Выберите Документы .
Названия клавиш, комбинации и последовательности Заглавные буквы. Используйте жирный шрифт для названий клавиш и сочетаний клавиш в инструкциях. Не ставьте пробел вокруг знака плюс (+) в сочетаниях клавиш.
Чтобы узнать, как ссылаться на сочетания клавиш и определенные клавиши, см. раздел Коллекция терминов «Клавиши и сочетания клавиш».
Shift, F7
Ctrl+Alt+Del
Alt, F, O
Пробел
Нажмите клавишу F1 .
Чтобы открыть вкладку Preview , выберите Alt+3 .
Макросы Обычно все в верхнем регистре. Используйте полужирное форматирование, если оно предопределено. Может быть моноширинным, если определено пользователем. Лечение варьируется. LOWORD
MASKROP
Элементы языка разметки (теги) Жирный. Капитализация разная.

Математические константы и переменные Курсив. а2 + b2 = с2
Меню Избегайте разговоров о меню. Вместо этого опишите, что клиент должен сделать.
Если вы должны обратиться к меню по имени, используйте жирный шрифт для имени меню.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Не включайте слово в меню , если оно не добавляет необходимой ясности.
Перейдите к Инструменты и выберите Изменить язык .
В меню Design выберите Colors , а затем выберите цветовую схему.
Новые условия Выделите курсивом первое упоминание нового термина, если вы собираетесь дать ему определение сразу в тексте. Microsoft Exchange состоит из компонентов сервера и клиента .
Палитры Избегайте разговоров о палитрах. Вместо этого опишите, что клиент должен сделать.
Если вы должны ссылаться на палитру по имени, используйте полужирное форматирование имени палитры.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Не включайте слово палитра , если оно не добавляет необходимой ясности.
В Colors дайте Windows выбрать цвет акцента из фона или выберите собственный цвет.
В палитре Color выберите цвет контура объекта.
Стекла Не говорите о панелях. Вместо этого опишите, что клиент должен сделать.
Если вы должны обратиться к панели по имени, используйте полужирное форматирование имени панели.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Не включайте слово панель , если оно не добавляет необходимой ясности.
Выберите стрелку рядом с коллекцией Стили , выберите Применить стили , а затем выберите стиль для изменения.
Если вам мешает панель «Применить стили» , просто переместите ее.
Заполнители (в синтаксисе и при вводе пользователем) Курсив. /v: версия
Введите пароль .
Товары, услуги, приложения и товарные знаки Обычно используется заглавная буква. Проверьте список товарных знаков Microsoft на наличие заглавных букв в названиях товарных знаков. Мышь Microsoft Arc Touch
Microsoft Word
Surface Pro
Блокнот
Сетевые подключения
Makefile
Программа RC
Косая черта При указании клиентам вводить косую черту, включите прописанный термин ( обратную косую черту или косая черта ), за которым следует символ в скобках. Введите две обратные косые черты (\\)….
Строки При ссылке на строки в коде, документе, веб-сайте или пользовательском интерфейсе используйте заглавные буквы в стиле предложения, если текст, на который вы ссылаетесь, не пишется с заглавной буквы по-другому. Заключить в кавычки. Выберите «Сейчас самое время».
Найдите в коде «семейство шрифтов: Segoe UI Semibold».
Вкладки Избегайте разговоров о вкладках. Вместо этого опишите, что клиент должен сделать.
Если вы должны ссылаться на вкладку по имени, используйте полужирное форматирование для имени вкладки.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Не включайте слово вкладку , если оно не добавляет необходимой ясности.
Выберите таблицу, а затем выберите Дизайн > Строка заголовка .
На вкладке Design выберите Строка заголовка .
Перейдите на вкладку Развернуть . В списке Конфигурация ….
Тумблеры Не говорите о переключателях. Вместо этого опишите, что клиент должен сделать.
Если вы должны обратиться к переключателю по имени, используйте жирный шрифт для имени переключателя.
Используйте заглавные буквы в предложениях, если вам не нужно соответствовать пользовательскому интерфейсу.
Включите слово для переключения , если оно вносит необходимую ясность.
Чтобы сделать текст и приложения более удобными для просмотра, включите переключатель под Включить высокую контрастность .
Чтобы сохранить все примененные фильтры, включите переключатель Пропустить все фильтры .
URL-адреса Все строчные буквы для полных URL-адресов. При необходимости разделяйте длинные URL-адреса перед косой чертой. Не делайте дефис.
См. также URL-адреса и веб-адреса.
www.microsoft.com
msdn.microsoft.com/downloads
Пользовательский ввод Обычно строчные буквы, если не учитывается регистр. Жирный или курсив, в зависимости от элемента. Если строка пользовательского ввода содержит текст-заполнитель, используйте курсив для этого текста. Введите hello world
Введите -p пароль
Окна Не говорите об окнах. Вместо этого сосредоточьтесь на том, что нужно клиенту.
Если вы должны обратиться к окну по имени, используйте обычный текст. Используйте заглавные буквы в стиле предложения, если вам не нужно соответствовать пользовательскому интерфейсу.
Используйте окно только как общий термин для области на экране ПК, где отображаются приложения и содержимое. Не используйте окно для ссылки на определенное диалоговое окно, блейд или аналогичный элемент пользовательского интерфейса.
Чтобы внедрить новый объект, переключитесь на исходный документ.
Легко переключаться между открытыми окнами.
Откройте новую вкладку Microsoft Edge в новом окне, чтобы вы могли просматривать вкладки рядом.
Элементы схемы XML Жирный. Капитализация разная. ElementType элемент
xml:space атрибут

В пользовательском интерфейсе и общем содержании

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


Опубликовано

в

от

Метки:

Комментарии

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *