Правила написания документов: 3 Общие требования к созданию документов / КонсультантПлюс
3 Общие требования к созданию документов / КонсультантПлюс
3 Общие требования к созданию документов
3.1 Документы могут создаваться на бумажном носителе и в электронной форме с соблюдением установленных правил оформления документов.
3.2 При создании документа на двух и более страницах вторую и последующие страницы нумеруют.
Номера страниц проставляются посередине верхнего поля документа на расстоянии не менее 10 мм от верхнего края листа.
Допускается создание документов на лицевой и оборотной сторонах листа. При двустороннем создании документов ширина левого поля на лицевой стороне листа и правого поля на оборотной стороне листа должны быть равны.
3.3. Для создания документов необходимо использовать свободно распространяемые бесплатные шрифты.
Для оформления документов рекомендуется использовать размеры шрифтов N 12, 13, 14.
При составлении таблиц допускается использовать шрифты меньших размеров.
(Измененная редакция, Изм.
(п. 3.3 в ред. Изменения N 1, утв. Приказом Росстандарта от 14.05.2018 N 244-ст)
3.4 Абзацный отступ текста документа — 1,25 см.
Заголовки разделов и подразделов печатаются с абзацным отступом или центрируются по ширине текста.
Многострочные реквизиты печатаются через один межстрочный интервал, составные части реквизитов отделяются дополнительным интервалом.
Текст документа печатается через 1 — 1,5 межстрочных интервала.
Если документ готовится для издания с уменьшением масштаба, текст печатается через два интервала.
Интервал между буквами в словах — обычный.
Интервал между словами — один пробел.
3.5 Текст документа выравнивается по ширине листа (по границам левого и правого полей документа).
Длина самой длинной строки реквизита при угловом расположении реквизитов не более 7,5 см.
Длина самой длинной строки реквизита при продольном расположении реквизитов не более 12 см.
3.6 Нормативными актами организации может быть предусмотрено выделение реквизитов «адресат», «заголовок к тексту» или «подпись», а также отдельных фрагментов текста полужирным шрифтом.
3.7 Нормативные акты организации, а также иные многостраничные документы могут оформляться с титульным листом. Титульный лист документа оформляется в соответствии с приложением А.
Открыть полный текст документа
Новый гост для оформления документов — новости в Т—Ж
Екатерина Мирошкина
экономист
Профиль автораС 1 июля 2018 года вступил в силу ГОСТ Р 7.0.97-2016. В нем описано, как оформлять деловые и служебные документы: официальные письма, приказы на работе, справки для людей и запросы в ведомства. Россия составила список рекомендаций для всех и предлагает их использовать, чтобы было красиво и понятно.
Мы прочитали его весь — вот главное.
Как составлять документы по госту
Вот несколько советов из стандарта:
- Используйте бесплатные шрифты: Times New Roman, Arial, Verdana.
- Выравнивайте заголовки по левому краю или по центру, а текст — по ширине.
- В заголовке пишите не только название, но и содержание документа — о чем он.
- Отметку о коммерческой тайне ставьте вверху справа. Советуем на каждом листе.
- У адресата инициалы пишите после фамилии, а в подписи — перед ней.
- Если адресат — фирма, то указывайте его в именительном падеже, а если человек — в дательном («кому»).
- Печать не должна заходить на подпись.
- Резолюцию можно ставить в любом месте или на отдельном бланке.
- На копии надо написать, где находится подлинник.
- Утвердите формы бланков с реквизитами документов, чтобы каждый раз не заполнять заново.
Зачем гост для документов
В России, как и в любой стране, пишут много документов: и чиновники, и бизнес, и мы с вами. От того, как документ оформлен, зависит, насколько легко его прочитать, найти нужное и ответить. Если все договорятся, что адресат там-то, заголовки выглядят так-то, а лучший шрифт для работы такой-то, то всем будет немного легче работать.
У каждой компании и в каждом ведомстве могут быть свои правила оформления документов. Но когда в стране есть об этом гост, компании и ведомства могут основывать свои правила на нем, а не изобретать каждый раз с нуля.
Этот гост — такая опорная точка: вы можете его не придерживаться, но если нужен ответ на вопрос «Как правильно с точки зрения России?» — вот он, этот ответ.
Применять или не применять гост — решайте сами. Штрафов за это нет. Но если вы где-то публично заявите: у нас, мол, документы по госту, — тогда уже должны применять обязательно.
Когда документ на нескольких страницах
Если документ из нескольких страниц, начиная со второй, их нужно нумеровать. Номер ставят посередине верхнего поля. Отступ сверху — минимум 10 мм. Можно печатать с двух сторон листа, но тогда поля боковые должны совпадать.
У некоторых документов может быть титульный лист. Например, у устава компании, отчета или пакета документов для торгов. Если хотите оформить титульный лист по правилам, в госте есть схема.
Шрифты — бесплатные
Шрифты рекомендуют такие:
- Times New Roman, размеры 13, 14.
- Arial, 12, 13.
- Verdana, 12, 13.
- Calibri, 14.
Или похожие по начертанию и размеру.
В таблицах шрифт может быть мельче. Важные реквизиты можно выделять полужирным: например, адресата заявления или заголовок документа.
Отступы и интервалы
Абзацный отступ — 1,25 см.
Заголовки разделов — с таким же абзацным отступом слева или по центру.
Вот требования к интервалам:
- Для текста — 1—1,5 межстрочных интервала.
- Если нужно уменьшить масштаб документа — тогда через 2 интервала.
- Между буквами — обычный.
- Между словами — один пробел.
- Реквизиты из нескольких строчек — через 1 интервал.
- Группы реквизитов — с дополнительным интервалом между группами.
Минимальные поля для всех документов:
- левое — 20 мм;
- правое — 10 мм;
- верхнее — 20 мм;
- нижнее — 20 мм.
Если документ хранится больше 10 лет — левое поле должно быть минимум 30 мм. Но все это логично использовать для бумажных документов, потому что их скрепляют, прошивают, а края бумаги за годы могут истрепаться. Для электронных документов это не так важно, но гост почему-то этого не учитывает, хотя для электронных документов он тоже работает.
Как расположить реквизиты на бланках
Выравнивание — по ширине
Документы по госту нужно выравнивать по ширине листа.
Если реквизиты пишут в углу, то самая длинная строчка должна быть не больше 7,5 см. Это примерно треть формата А4.
Если реквизиты документа не в углу, а по центру, их тоже нельзя растягивать на всю ширину. Максимум на 12 см — это половина ширины листа.
От редакции: выравнивая документ по ширине листа, включите переносы, иначе между словами будут огромные дыры. Либо люди, которые составляли гост, не знают об этом эффекте, либо у них нет глаз или вкуса
Реквизиты документа
Товарный знак или логотип — вверху посередине или слева. Можно указать название компании, магазина или бизнеса — которое неофициальное, но к нему привыкли.
В верхней части документа нужно написать, какая компания его составила, ее адрес, телефон и электронную почту, ИНН, ОГРН и другие реквизиты с учетом назначения документа.
По госту нужно написать и название документа. Это не касается только деловых и служебных писем. Если это приказ — нужно так и указать.
Дату ставят вверху. Причем не ту, когда составили документ, а когда подписали. Форматы даты такие:
- 19.10.2018;
- 19 октября 2018 г.
Отметка о коммерческой тайне
Если в документе есть что-то секретное, нужно написать об этом прямо в реквизитах. В старом госте такого вообще не было. Слова «Коммерческая тайна», «Только для служебного использования» или «Конфиденциально» нужно писать в правом верхнему углу. Если документ на нескольких листах, пишут на титульном.
Как указать адресата: кому и куда
Адресатом может быть фирма или человек. Его всегда пишут справа — под реквизитами автора документа или в верхнему углу. Тут есть изменения по сравнению с прежними правилами.
Если адресат — человек, нужно писать в дательном падеже:
Генеральному директору
ООО «Ромашка»
Иванову И. И.
Если адресат — компания, тогда название пишут в именительном падеже, хотя это тоже «кому»:
Министерство финансов Российской федерации
Если адресат — подразделение или филиал, название фирмы пишут в именительном, а подразделение и должность — в дательном падеже:
ООО «Завод Литий»
Начальнику транспортного цеха
Петрову П. П.
Смотрите, как изменилось место для инициалов адресата. По старому госту их следовало писать перед фамилией:
А теперь — после фамилии:
А еще можно добавить «г-ну» или «г-же». Раньше так было не принято.
Если адресатов несколько
По госту в документе не должно быть больше четырех адресатов. Если их все-таки больше, тогда есть два варианта:
- составить отдельный список адресатов и к нему приложить документ;
- указать адресатов без фамилий, просто: руководителям филиалов такого-то банка.
Перед каждым следующим адресатом не нужно писать слово «копия».
Судя по всему, гост не учитывает особенности электронных документов. В них адресата на бланке можно не указывать. Или их может быть больше четырех без потери информативности. А еще в электронной переписке и электронных документах физически невозможно перечислить адресатов отдельным списком.
Что делать? 02.10.17Я на Бали, а заказчики в России. Как подписать договор?
Заголовок документа
Из заголовка должно быть понятно не только что это за документ, но и о чем он.
Плохой заголовок | Хороший заголовок |
---|---|
Приказ | Приказ о повышении заработной платы |
Плохой заголовок
Хороший заголовок
Приказ
Приказ о повышении заработной платы
Заголовок документа выравнивают по левому краю или по центру. Если документ из 4—5 строк, можно без заголовка. Раньше тоже было можно, но для формата А5. Теперь условие о формате убрали, потому что гост касается и электронных писем тоже.
Если есть ссылки на другие документы
Если документ составили на основе какого-то закона, письма, постановления, внутреннего приказа компании, то его нужно указывать со всеми реквизитами: номером, датой, составителем, названием.
Если есть приложения, их перечисляют внизу, нумеруют список и указывают количество страниц.
От какого лица писать текст
Это зависит от вида документа. В коммерческом предложении покупателю можно писать как захочется. Но в официальных документах, уставах и кадровых приказах так лучше не делать.
Вид документа | Форма обращения | Пример |
---|---|---|
Приказ | Первое лицо, единственное число | Приказываю |
Документ от имени органа из нескольких человек | Третье лицо, единственное число | Собрание собственников решило (а не «мы решили») |
Протокол | Третье лицо, множественное число | Выступили, слушали, решили |
Инструкции, положения, акты, справки, документы с описаниями фактов и выводов | Третье лицо, единственное или множественное число | Комиссия проверила, отдел организовал, на собрании присутствовали |
Деловые и служебные письма | Первое лицо, любое число или третье лицо, единственное число | Прошу направить, считаем необходимым, отдел продаж предлагает |
Вид документа
Приказ
Форма обращения
Первое лицо, единственное число
Пример
Приказываю
Вид документа
Документ от имени органа из нескольких человек
Форма обращения
Третье лицо, единственное число
Пример
Собрание собственников решило (а не «мы решили»)
Вид документа
Протокол
Форма обращения
Третье лицо, множественное число
Пример
Выступили, слушали, решили
Вид документа
Инструкции, положения, акты, справки, документы с описаниями фактов и выводов
Форма обращения
Третье лицо, единственное или множественное число
Пример
Инструкции, положения, акты, справки, документы с описаниями фактов и выводов
Вид документа
Деловые и служебные письма
Форма обращения
Первое лицо, любое число или третье лицо, единственное число
Пример
Прошу направить, считаем необходимым, отдел продаж предлагает
С какой буквы писать должность
По госту с большой, но только в обращениях. А вы уж сами решайте.
А можно писать «уважаемый»?
По госту да, причем с восклицательным знаком. Вот так:
Уважаемый господин Губернатор!
Уважаемый господин Иванов!
Уважаемая Елена Ивановна!
Подпись — инициалы вперед
В адресате и тексте инициалы пишут после фамилии: Иванов И. И. А в подписи — перед ней: И. И. Иванов. Мы не знаем, почему так.
Если документ на фирменном бланке, название компании в подписи можно не писать. Если вверху уже указана должность автора, то внизу хватит только подписи и инициалов с фамилией.
На фирменном бланке не указывают название компании в подписиЕсли подписей несколько, их располагают друг под другом по подчиненности или убыванию важности. Сначала директор, потом зам, а потом зам зама.
Сначала подписывает директор, потом — главбухЕсли в договоре или письме уже указали директора, а подписать пришлось кому-то другому по доверенности, нельзя писать «за» перед должностью, хотя многие так делают. Нужно от руки исправить фамилию или поставить штамп.
Появилась отметка об электронной подписи
Теперь гост не только для бумажных документов. И не только для обычных писем по электронной почте. Если подпись электронная, ее реквизиты должны стоять там же, где стояла бы ручная. Она не может перекрывать текст.
По госту отметка электронной подписи должна выглядеть и располагаться вот такВообще, в госте неполная информация об электронной подписи. Пример отметки выглядит странно. Там нет вида подписи, полномочий и названия удостоверяющего центра.
Если вам пришло что-то с отметкой об электронной подписи, будьте внимательны, чтобы не попасть в сети мошенников. Даже если она вроде бы выглядит по госту — лучше перепроверьте.
Как ставить печать
Печать не должна перекрывать ручную подпись. Хотя некоторые бухгалтеры, кадровики и секретари упорно ставят печать на подпись. Это не по госту.
Но печати может и не быть, это не нарушение. Хотя в госте об этом не сказано — наоборот, формулировка такая, будто печать обязательная. Но мы-то знаем, что нет.
Как указать исполнителя
Внизу нужно указать фамилию, имя, отчество и телефон человека, который составил документ. Можно добавить электронную почту и должность. Исполнителя пишут мельче — это по госту. Но можно и основным кеглем.
Как заверить копию
Отметку о том, что это копия и она заверена, ставят внизу документа. По госту — именно внизу. Выглядит это так:
Так заверяют копию трудовой книжки по гостуЕсли заверяют копию для другой организации, нужно дописать, где хранится оригинал. Например, так:
Подлинник трудовой книжки находится в ООО «Ромашка».
Можно добавить номер дела и поставить печать, если они есть.
Как поставить резолюцию
Если вам принесли служебную записку с просьбой повысить оклад, купить новый компьютер или дать отгул, то на любом свободном месте документа можно написать, что все согласовано или что отказано, и добавить фамилию с инициалами, подпись и дату. Иногда резолюцию составляют на отдельном бланке формата А5 или А6.
Как оформлять разные надписи на документах по госту
Как поставить гриф «Утверждаю»
Гриф утверждения ставится на документах, которые утверждает должностное лицо или коллегиальный орган, например собрание.
Гриф ставится в правом верхнем углу первого листа документа. Если документ утверждает должностное лицо, то гриф состоит из слова «Утверждаю», должности того, кто утвердил, его подписи, инициалов, фамилии и даты.
Если документ утверждается решением коллегиального органа, то в грифе «Утверждено» указывается наименование органа, который утвердил документ, и в скобках — дата и номер протокола, которым зафиксировали решение.
«Утверждаю» на документе — образец «Утверждено» на документе — образецХотим соблюдать гост. Что делать?
Утвердите форму бланков для каждого вида документа: где и что должно быть написано. Это нужно сделать и для бумажных, и для электронных документов. Если документ отправляют по электронной почте или с электронной подписью, нужно предусмотреть защиту от изменений.
В госте есть схемы расположения реквизитов для разных документов. Если хотите соблюдать стандарт — полюбопытствуйте. Раньше было три формы, а теперь их семь. Там готовые форматы бланков. Если у вас нет особых требований к дизайну, можно использовать эти шаблоны.
Не забывайте, что гост добровольный. Его можно учитывать для порядка в документах, особенно если у вас их много, но штрафов за оформление не по госту нет. А кроме требований на уровне государства есть еще обычаи делового этикета, привычки и корпоративные стандарты. Решайте сами, что вам важнее.
10 самых интересных требований госта для интернет-магазинов
Оформление документов
Рекомендации к оформлению документов
В основе приведенных ниже рекомендаций по оформлению документов лежат требования ГОСТ Р 6.30-2003 «Организационно-распорядительная документация. Требования к оформлению документов. Методические рекомендации по внедрению» (утверждено Росархивом).
Формат листа А4: основной текст документа – по ширине; шрифт Times New Roman Cyr размером № 12, левое поле – 20 — 30 мм, правое поле – 10 — 20 мм, верхнее поле – 20 мм, нижнее поле – 20 мм, первая строка (начало абзаца текста) – отступ 1,25; межстрочный интервал по основному тексту – 1,2 — полуторный; интервал абзаца «после» — 6 пт.
Шапка документа — отступ слева — 7,5 — 8 см; шрифт Times New Roman Cyr размером № 10; по левому краю; межстрочный интервал – одиночный
адресат
отступ с межстрочным интервалом – одиночный
от кого и адрес заявителя
два отступа – шрифт Times New Roman Cyr размером № 12; с межстрочным интервалом – одиночный
Заголовок документа – по центру; с разрядкой между букв; шрифт Times New Roman Cyr размером № 14 — 16; интервал абзаца «после» — 2 пт.
Подзаголовок документа – по центру; с разрядкой между букв; шрифт Times New Roman Cyr размером № 10; интервал абзаца «после» — 0 пт.
Отступ от основного текста – шрифт Times New Roman Cyr размером № 12; с межстрочным интервалом – одиночный.
Текст документа – по ширине; левое поле – 20 — 30 мм; правое поле – 10 — 20 мм; шрифт Times New Roman Cyr размером № 12; с межстрочным интервалом – 1,2 — 1,5; интервал абзаца «после» — 6 пт.
Примечания – по ширине; левое поле – 20 — 30 мм; правое поле – 10 — 20 мм; шрифт Times New Roman Cyr размером № 10; с межстрочным интервалом – одиночный; интервал абзаца «после» — 2-3 пт. Текст – нумерация по мере упоминания в тексте.
Поле даты, подписи и расшифровки подписи – шрифт Times New Roman Cyr размером № 12; с межстрочным интервалом – одиночный; интервал абзаца «после» — 0 пт.
Расшифровка подписи (в скобках) – И. О. Фамилия.
В зависимости от объема текста указанные выше рекомендации могут быть изменены с целью удобочитаемости и уменьшения объема текста. Например, могут быть изменены размеры полей, размер шрифта основного текста и прочее.
Требования к оформлению документации | Кафедра прикладной математики
На кафедре прикладной математики при оформлении выпускных аттестационных работ, отчетов по курсовым проектам и работам, отчетов по практикам, отчетов по лабораторным работам и другой документации от студентов требуется придерживаться требований ДСТУ 3008-95 «Документация. Отчеты в сфере науки и техники. Структура и правила оформления».
Для удобства студентов, кафедра прикладной математики подготовила указания на основе этого стандарта
Все документы нужно выполнять на страницах с такими параметрами:
- формат А4 (210х297 мм)
- поля: верхнее — 2 см, нижнее — 2 см, левое — 2 см, правое — 1 см
- страницы следует нумеровать арабскими цифрами, придерживаясь сквозной нумерации на протяжении всего текста документа. Номер страницы проставляется в правом верхнем углу страницы без точки в конце
- на всех листах, предшествующих «Змісту», номер страницы не ставится
Основной текст документа должен быть выполнен на украинском языке и отформатирован следующим образом:
- шрифт — Times New Roman, 14 кегль
- междустрочный интервал — 1,5 строки, безо всяких отступов «до» и «после»
- абзацный отступ должен быть одинаковым на протяжении всего текста и равняться 1,25 см
- выравнивание текста — по ширине
Структурными элементами документа являются разделы, подразделы и пункты, а также специальные структурные элементы — «Анотація» (приводится по необходимости, может быть на украинском и английском языке), «Зміст», «Перелік умовних позначень, скорочень і термінів» (приводится по необходимости), «Вступ», «Висновки», «Перелік посилань». При этом:
- у разделов, подразделов и пунктов должны быть заголовки
- заголовки разделов и специальных структурных элементов следует размещать посередине строки и печатать заглавными буквами без точки в конце, не подчеркивая и не выделяя (полу)жирным
- заголовки подразделов и пунктов следует начинать с абзацного отступа и печатать строчными буквами, кроме первой заглавной, без точки в конце, не подчеркивая и не выделяя (полу)жирным
- если заголовок состоит из двух и более предложений, они разделяются точкой
- расстояние между заголовком и последующим либо предшествующим текстом должно быть в две строки. Между двумя заголовками пропусков строк быть не должно
- каждый раздел и специальный структурный элемент должен начинаться с новой страницы
- подразделы и пункты должны начинаться на текущей странице
- не допускается размещать заголовок подраздела, пункта в нижней части страницы, если после него размещена только одна строка текста
- у разделов должна быть порядковая нумерация в рамках документа, они должны обозначаться арабскими цифрами без точки, например, 1, 2, 3 и т. д.
- у подразделов должна быть порядковая нумерация арабскими цифрами в рамках каждого раздела; номер подраздела состоит из номера раздела и порядкового номера подраздела, разделенных точкой; после номера подраздела точка не ставится, например, 1.1, 1.2 и т. д.
- у пунктов должна быть порядковая нумерация арабскими цифрами в рамках каждого подраздела; номер пункта состоит из номера раздела, номера подраздела и порядкового номера пункта, разделенных точками; после номера пункта точка не ставится, например, 1.1.1, 1.1.2 и т. д.
В этом структурном элементе документа необходимо привести и расшифровать сокращения терминов и понятий, встречающихся в тексте более двух раз (кроме общепринятых). При этом в самом тексте после первого упоминания соответствующего термина или понятия необходимо в скобках привести его сокращение.
Сокращения необходимо приводить в алфавитном порядке. Сокращения на латинице должны предшествовать сокращениям на кириллице.
Если в документе сокращений нет, соответствующий структурный элемент можно пропустить.
Зміст«Зміст» документа необходимо оформлять согласно приложению Б к ДСТУ 3008-95 (однако, смотри ниже шаблоны оформления).
Рисунки и таблицыПри размещении рисунков и таблиц необходимо придерживаться следующих требований:
- рисунки следует размещать непосредственно после текста, где они упомянуты впервые, либо на следующей странице
- название рисунка размещается под ним посередине строки. Название рисунка состоит из слова «Рисунок», номера рисунка, а также заголовка рисунка, отделяемого коротким тире. У рисунков должна быть порядковая нумерация арабскими цифрами в рамках раздела, номер рисунка состоит из номера раздела и порядкового номера рисунка, разделенных точкой. Пример названия рисунка: «Рисунок 3. 1 – Схема розміщення» — первый рисунок третьего раздела
- блок-схемы должны оформляться как рисунки и соответствовать ГОСТ 19.701-90 «Единая система программной документации. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения»
- таблицы следует размещать непосредственно после текста, где они упомянуты впервые, либо на следующей странице
- название таблицы размещается над ней по левому краю без абзацного отступа. Название таблицы состоит из слова «Таблиця», номера таблицы, а также заголовка таблицы, отделяемого коротким тире. У таблиц должна быть порядковая нумерация арабскими цифрами в рамках раздела, номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой. Пример названия таблицы: «Таблиця 5.3 – Результати обчислень» — третья таблица пятого раздела
- если строки таблицы выходят за пределы страницы, таблица разделяется на части, при этом часть таблицы переносится на следующую страницу, а шапка таблицы повторяется в каждой части таблицы. При разделе таблицы на части допускается ее шапку заменять на номера столбцов, нумеруя их арабскими цифрами в первой части таблицы. В случае переноса таблицы над ее частями, перенесенными на следующие страниц, слева без абзацного отступа пишется: «Продовження таблиці __» с указанием номера таблицы
- выше и ниже каждого рисунка и таблицы должна быть оставлена одна пустая строка
Форматируя списки, необходимо учитывать следующее:
- перед списком ставится двоеточие
- перед каждой позицией нумерованного списка следует ставить строчную букву украинского алфавита с закрывающей скобкой
- перед каждой позицией ненумерованного списка следует ставить дефис
- если у нумерованного списка два уровня вложения, то для второго уровня следует использовать арабские цифры с закрывающей скобкой, например:
а) форма і розмір клітин;
б) живий склад клітин:
1) частини клітин;
2) неживі включення протопластів;
в) утворення тканини;
- списки первого уровня детализации печатаются строчными буквами с отступом 1,25 см, второго уровня — строчными буквами с отступом 2 см
Формулы в документе должны быть выполнены согласно следующим требованиям:
- формулы размещаются непосредственно после текста, где они упомянуты, посередине страницы
- выше и ниже каждой формулы должна быть оставлена одна пустая строка
- у формул должна быть порядковая нумерация арабскими цифрами в рамках раздела; номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например, (1. 3) — третья формула первого раздела
- формулы в виде рисунков не допускаются
Все литературные источники должны оформляться согласно ДСТУ ГОСТ 7.1:2006 «Система стандартов по информации, библиотечному и издательскому делу. Библиографическая запись. Библиографическое описание. Общие требования и правила составления». При этом:
- литературные источники нумеруются в порядке их упоминания в тексте
- не допускаются ссылки на источники, не представляющие научной ценности (например, страницы Википедии)
Примеры оформления ссылок приведены в документе.
ПриложенияПриложения следует оформлять на страницах документа, следующих за «Переліком посилань». При этом:
- каждое приложение должно начинаться с новой страницы
- у приложения должен быть заголовок, напечатанный сверху строчными буквами с первой заглавной по центру. Посередине строки над заголовком строчными буквами с первой заглавной должно быть напечатано слово «Додаток __» и заглавная буква, обозначающая приложение
- приложения следует обозначать последовательно заглавными буквами украинского алфавита, за исключением букв Ґ, Є, З, І, Ї, Й, О, Ч, Ь, например, Додаток А, Додаток Б и т. д.
В тексте документа должны быть ссылки на все рисунки и таблицы, а также на все источники из «Переліку посилань». При этом:
- ссылки в тексте на источники следует обозначать порядковым номером согласно «Переліку посилань», выделенным двумя квадратными скобками, например, […] у роботах [1–7] […]
- при ссылках на разделы, подразделы, пункты, рисунки, таблицы, формулы, приложения указываются их номера. Следует писать:
- […] у розділі 4 […]
- […] дивись 2.1 […]
- […] (див. 3.2) […]
- […] за 3.3.1 […]
- […] відповідно до 2. 3.3 […]
- […] на рисунку 1.3 […]
- […] у таблиці 3.2 […]
- […] за формулою (3.1) […]
- […] у рівняннях (1.23)–(1.25) […]
- […] у додатку Б […]
Листинги программ, как правило, приводятся в отдельном приложении.
Оформлять листинги разрешается шрифтом Times New Roman 8 кегля, с одинарным междустрочным интервалом.
Шаблоны оформленияКафедра прикладной математики подготовила шаблоны, учитывающие указанные выше требования:
Законодательная основа | Гражданский кодекс Российской Федерации (часть четвертая) Глава 72. Патентное право | Федеральный закон от 18.12.2006 № 231-ФЗ |
Государственная регистрация изобретения и выдача патента на изобретение, его дубликата | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по государственной регистрации изобретения и выдаче патента на изобретение, его дубликата | приказ |
Правила составления, подачи и рассмотрения документов, являющихся основанием для совершения юридически значимых действий по государственной регистрации изобретений, и их формы | приказ Минэкономразвития РФ от 25.05.2016 № 316 | |
Требования к документам заявки на выдачу патента на изобретение | ||
Состав сведений о заявке на выдачу патента на изобретение, публикуемых в официальном бюллетене Федеральной службы по интеллектуальной собственности | ||
Порядок проведения информационного поиска при проведении экспертизы по существу по заявке на выдачу патента на изобретение и представления отчета о нем | ||
Порядок и сроки информирования заявителя о результатах проведения информационного поиска по заявке на выдачу патента на изобретение и публикации отчета о таком поиске | ||
Порядок и условия проведения информационного поиска по заявке на выдачу патента на изобретение по ходатайству заявителя или третьих лиц и предоставления сведений о его результатах | ||
Состав сведений о выдаче патента на изобретение, публикуемых в официальном бюллетене Федеральной службы по интеллектуальной собственности | ||
Состав сведений, указываемых в патенте на изобретение | ||
Форма патента на изобретение | ||
Правила проведения проверки наличия в заявках на выдачу патента на изобретение или полезную модель, созданные в Российской Федерации, сведений, составляющих государственную тайну | постановление Правительства РФ от 24. 12.2007 № 928 (с изменениями от 27.02.2015) | |
Порядок проведения предварительного информационного поиска в отношении заявленного изобретения и предварительной оценки его патентоспособности, представления отчета о предварительном информационном поиске и заключения по результатам предварительной оценки патентоспособности в отношении заявленного изобретения, публикации отчета о предварительном информационном поиске в отношении заявленного изобретения | приказ Минэкономразвития РФ от 26.05.2021 № 295 | |
Рекомендации, руководства и информационные письма |
| |
Государственная регистрация полезной модели и выдача патента на полезную модель, его дубликата | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по государственной регистрации полезной модели и выдаче патента на полезную модель, его дубликата | приказ |
Правила составления, подачи и рассмотрения документов, являющихся основанием для совершения юридически значимых действий по государственной регистрации полезных моделей, и их формы | приказ Минэкономразвития РФ от 30.09.2015 № 701 | |
Требования к документам заявки на выдачу патента на полезную модель | ||
Состав сведений о выдаче патента на полезную модель, публикуемых в официальном бюллетене Федеральной службы по интеллектуальной собственности | ||
Состав сведений, указываемых в форме патента на полезную модель | ||
Форма патента на полезную модель | ||
Рекомендации, руководства и информационные письма | ||
Ознакомление с документами заявки на выдачу патента на изобретение, полезную модель, промышленных образец и выдача копий таких документов | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по ознакомлению с документами заявки на выдачу патента на изобретение, полезную модель, промышленный образец и выдаче копий таких документов | приказ Минэкономразвития РФ от 28. 08.2015 № 615 |
Порядок ознакомления с документами, содержащимися в заявке на выдачу патента на изобретение, промышленный образец, и выдачи копий таких документов, ознакомления с документами, содержащимися в заявке на выдачу патента на полезную модель, ознакомления с отчетами о предварительном информационном поиске и информационном поиске в отношении заявленных изобретения или полезной модели и заключением о результатах предварительной оценки их патентоспособности, с отчетом об информационном поиске в отношении заявленного промышленного образца, а также другими документами Федеральной службы по интеллектуальной собственности по заявке в связи с государственной регистрацией изобретения, полезной модели или промышленного образца | приказ Минэкономразвития РФ от 03.06.2021 № 306 | |
Государственная регистрация распоряжения по договору исключительным правом на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, зарегистрированные топологию интегральной микросхемы, программу для электронных вычислительных машин, базу данных | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по государственной регистрации распоряжения по договору исключительным правом на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, зарегистрированные топологию интегральной микросхемы, программу для электронных вычислительных машин, базу данных | приказ Минэкономразвития РФ от 10. 06.2016 № 371 |
Правила государственной регистрации распоряжения исключительным правом на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, зарегистрированные топологию интегральной микросхемы, программу для ЭВМ, базу данных по договору и перехода исключительного права на указанные результаты интеллектуальной деятельности без договора | постановление Правительства РФ от 24.12.2015 № 1416 | |
Государственная регистрация перехода исключительного права на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, наименование места происхождения товара, зарегистрированные топологию интегральной микросхемы, программу для электронных вычислительных машин, базу данных без договора | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по государственной регистрации перехода исключительного права на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, наименование места происхождения товара, зарегистрированные топологию интегральной микросхемы, программу для электронных вычислительных машин, базу данных без договора | приказ Минэкономразвития РФ от 30. 09.2015 № 707 |
Правила государственной регистрации распоряжения исключительным правом на изобретение, полезную модель, промышленный образец, товарный знак, знак обслуживания, зарегистрированные топологию интегральной микросхемы, программу для ЭВМ, базу данных по договору и перехода исключительного права на указанные результаты интеллектуальной деятельности без договора | постановление Правительства РФ от 24.12.2015 № 1416 | |
Рассмотрение заявления правообладателя о предоставлениилюбому лицу права использованияизобретения, полезной модели или промышленного образца (открытой лицензии), ходатайства об отзыве заявления об открытой лицензии | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по рассмотрению заявления правообладателя о предоставлении любому лицу права использования изобретения, полезной модели или промышленного образца (открытой лицензии), ходатайства об отзыве заявления об открытой лицензии | приказ Минэкономразвития РФ от 29. 11.2021 № 716 |
Государственная регистрация сделок, предусматривающих использование единых технологий гражданского назначения на территориях иностранных государств | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по государственной регистрации сделок, предусматривающих использование единых технологий гражданского назначения на территориях иностранных государств |
|
Порядок государственной регистрации сделок, предусматривающих использование единых технологий гражданского назначения на территориях иностранных государств | приказ Минэкономразвития РФ от 27.08.2015 № 609 | |
Продление срока действия исключительного права на изобретение и удостоверяющего это право патента | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по продлению срока действия исключительного права на изобретение и удостоверяющего это право патента | приказ Минэкономразвития РФ от 29. 11.2021 № 715 |
Порядок выдачи и действия дополнительного патента на изобретение, продления срока действия патента на изобретение | приказ Минэкономразвития РФ от 03.11.2015 № 809 | |
Восстановление действия патентана изобретение, полезную модель или промышленный образец | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по восстановлению действия патента на изобретение, полезную модель или промышленный образец | приказ Минэкономразвития РФ от 29.11.2021 № 717 |
Досрочное прекращение действия патента на изобретение, полезную модель, промышленный образец, правовой охраны товарного знака, знака обслуживания, общеизвестного товарного знака, действия свидетельства об исключительном праве на географическое указание и на наименование места происхождения товара по заявлению правообладателя | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по досрочному прекращению действия патента на изобретение, полезную модель, промышленный образец, правовой охраны товарного знака, знака обслуживания, коллективного знака, общеизвестного товарного знака, действия исключительного права на географическое указание или наименование места происхождения товара по заявлению правообладателя | Приказ Роспатента от 27. 07.2020 № 103 |
Формы заявления о досрочном прекращении правовой охраны | Приказ Минэкономразвития РФ от 20.08.2020 № 549 | |
Внесение изменений в государственные реестрыизобретений, полезных моделей, промышленных образцов Российской Федерации, а также в патенты | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по внесению изменений в государственные реестры изобретений, полезных моделей, промышленных образцов Российской Федерации, а также в патенты на изобретение, полезную модель, промышленный образец | приказ Минэкономразвития РФ от 03.11.2015 № 811 |
Подача возражений и заявлений и их рассмотрение в Палате по патентным спорам | Правила подачи возражений и заявлений и их рассмотрения в Палате по патентным спорам | приказ Роспатента от 22. 04.2003 № 56 |
Публикация решений судов о допущенных нарушениях исключительных прав | Административный регламент предоставления Федеральной службой по интеллектуальной собственности государственной услуги по публикации решений судов о допущенных нарушениях исключительных прав | приказ Минэкономразвития РФ от 21.08.2015 № 579 |
Перечень юридически значимых действий, за совершение которых взимаются патентные и иные пошлины, их размеры, порядок и сроки уплаты | Положение о патентных и иных пошлинах за совершение юридически значимых действий, связанных с патентом на изобретение, полезную модель, промышленный образец, с государственной регистрацией товарного знака и знака обслуживания, с государственной регистрацией и предоставлением исключительного права на наименование места происхождения товара, а также с государственной регистрацией перехода исключительных прав к другим лицам и договоров о распоряжении этими правами | постановление Правительства РФ от 10. 12.2008 № 941 |
Документы
Протокол КК от 09112021 4.pdf172 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 09 ноября 2021 года № 4
Координационный комитет
Оценка результатов
Инструкция по заполнению заявки 2022-1.pdf1 МБ
инструкция (методические рекомендации) по заполнению заявки на участие во втором конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2022 году
Методические материалы
Первый конкурс 2022
Рекомендации по подготовке бюджета 2022-1.pdf369 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие во втором конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2022 году
Методические материалы
Первый конкурс 2022
Шаблон заявки 2022-1. docx134 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 31 августа 2021 года)
Методические материалы
Первый конкурс 2022
Положение о конкурсе 11062021.pdf260 КБ
положение о первом конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2022 году
Первый конкурс 2022
Положения
Конкурсная документация
Объявление 11062021.pdf130 КБ
объявление о проведении конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2022 году
Конкурсная документация
Первый конкурс 2022
Протокол КК от 11062021 3.pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 11 июня 2021 года № 3
Второй конкурс 2021
Координационный комитет
Протокол ОЭС от 07062021 2. pdf179 КБ
протокол заседания объединенного экспертного совета от 7 июня 2021 года № 2
Второй конкурс 2021
Объединенный экспертный совет
Протокол ОЭС от 25032021 1.pdf160 КБ
протокол заседания объединенного экспертного совета от 25 марта 2021 года № 1
Второй конкурс 2021
Объединенный экспертный совет
Протокол КК от 03032021 2.pdf92 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 3 марта 2021 года № 2
Координационный комитет
Рекомендации по подготовке бюджета 2021-2.pdf394 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие во втором конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Второй конкурс 2021
Методические рекомендации по оценке заявок. pdf358 КБ
методические рекомендации по оценке заявок на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 24 декабря 2020 года)
Независимая экспертиза
Шаблон заявки 2021-2.docx123 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 31 января 2021 года)
Второй конкурс 2021
Инструкция по заполнению заявки 2021-2.pdf857 КБ
инструкция (методические рекомендации) по заполнению заявки на участие во втором конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Второй конкурс 2021
Положение о конкурсе 14012021.pdf274 КБ
положение о втором конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Положения
Второй конкурс 2021
Протокол КК от 14012021 1. pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 14 января 2021 года № 1
Координационный комитет
Первый конкурс 2021
Протокол ОЭС от 24122020 7.pdf184 КБ
протокол заседания объединенного экспертного совета от 24 декабря 2020 года № 7
Первый конкурс 2021
Объединенный экспертный совет
Протокол ОЭС от 26102020 6.pdf156 КБ
протокол заседания объединенного экспертного совета от 26 октября 2020 года № 6
Первый конкурс 2021
Объединенный экспертный совет
Рекомендации по подготовке бюджета 2021-1.pdf390 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в первом конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Первый конкурс 2021
Инструкция по заполнению заявки 2021-1. pdf700 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в первом конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Первый конкурс 2021
Шаблон заявки 2021-1.docx89 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 31 августа 2020 года)
Первый конкурс 2021
Форма договора 11012021.pdf300 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 11 января 2021 года)
Первый конкурс 2021
Методические материалы
Второй конкурс 2021
Первый конкурс 2022
Положение о конкурсе 28082020.pdf279 КБ
положение о первом конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Первый конкурс 2021
Положения
Объявление 28082020. pdf132 КБ
объявление о проведении конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества в 2021 году
Первый конкурс 2021
Второй конкурс 2021
Протокол КК от 28082020 3.pdf867 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 28 августа 2020 года № 3
Координационный комитет
Специальный конкурс 2020
Протокол ОЭС от 21082020 5.pdf75 КБ
протокол заседания объединенного экспертного совета от 21 августа 2020 года № 5
Объединенный экспертный совет
Специальный конкурс 2020
Протокол ОЭС от 23072020 4.pdf69 КБ
протокол заседания объединенного экспертного совета от 23 июля 2020 года № 4
Объединенный экспертный совет
Специальный конкурс 2020
Положение о конкурсе 25032020. pdf271 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2020 году, с изменением, внесённым 25 марта 2020 года)
Положения
Второй конкурс 2020
Логотип фонда для СМИ и контрагентов.zip6 МБ
логотип фонда для СМИ и контрагентов
Фирменный стиль для СМИ
Руководство по использованию логотипа для СМИ и контрагентов.pdf368 КБ
руководство по использованию логотипа для СМИ и контрагентов
Фирменный стиль для СМИ
Логотип фонда для победителей.zip6 МБ
логотип фонда для победителей
Фирменный стиль
Руководство по использованию логотипа для победителей.pdf2 МБ
руководство по использованию логотипа для победителей
Фирменный стиль
Протокол КК от 15062020 2. pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 15 июня 2020 года № 2
Координационный комитет
Второй конкурс 2020
Протокол ОЭС от 09062020 3.pdf189 КБ
протокол заседания объединенного экспертного совета от 9 июня 2020 года № 3
Объединенный экспертный совет
Второй конкурс 2020
Протокол ОЭС от 15042020 2.pdf159 КБ
протокол заседания объединенного экспертного совета от 15 апреля 2020 года № 2
Второй конкурс 2020
Объединенный экспертный совет
Положение о конкурсе 15062020.pdf220 КБ
положение о специальном конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (в 2020 году)
Положения
Специальный конкурс 2020
Шаблон заявки специальный конкурс 2020. docx77 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 15 июня 2020 года)
Специальный конкурс 2020
Форма договора 31082020.pdf242 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 31 августа 2020 года)
Специальный конкурс 2020
Рекомендации по подготовке бюджета специальный конкурс 2020.pdf382 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в специальном конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (2020 года)
Специальный конкурс 2020
Объявление 15062020.pdf125 КБ
объявление о проведении в 2020 году специального конкурса на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Специальный конкурс 2020
Инструкция по заполнению заявки специальный конкурс 2020. pdf605 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в специальном конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (2020 года)
Специальный конкурс 2020
распоряжение Президента Российской Федерации от 6 мая 2020 г. № 120-рп
Специальный конкурс 2020
Решения Президента
Изменение в положение о конкурсе.pdf100 КБ
изменение в положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2020 году)
Второй конкурс 2020
Шаблон заявки 2020-2.docx82 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 26 февраля 2020 года)
Второй конкурс 2020
Инструкция по заполнению заявки 2020-2. pdf724 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2020 года)
Второй конкурс 2020
Форма договора 25022020.pdf233 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 25 февраля 2020 года)
Второй конкурс 2020
Рекомендации по подготовке бюджета 2020-2.pdf397 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2020 года)
Второй конкурс 2020
Объявление 21022020.pdf128 КБ
объявление о проведении в 2020 году второго конкурса на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Второй конкурс 2020
Положение о конкурсе 21022020. pdf271 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2020 году)
Положения
Второй конкурс 2020
Протокол КК от 21022020 1.pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 21 февраля 2020 года № 1
Координационный комитет
Первый конкурс 2020
Протокол ОЭС от 17022020 1.pdf182 КБ
протокол заседания объединенного экспертного совета от 17 февраля 2020 года № 1
Объединенный экспертный совет
Первый конкурс 2020
Протокол ОЭС от 10122019 5.pdf159 КБ
протокол заседания объединенного экспертного совета от 10 декабря 2019 года № 5
Объединенный экспертный совет
Первый конкурс 2020
Протокол КК от 14102019 3. pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 14 октября 2019 года № 3
Второй конкурс 2019
Координационный комитет
Протокол ОЭС от 07102019 4.pdf188 КБ
протокол заседания объединенного экспертного совета от 7 октября 2019 года № 4
Второй конкурс 2019
Объединенный экспертный совет
Протокол ОЭС от 13082019 3.pdf170 КБ
протокол заседания объединенного экспертного совета от 13 августа 2019 года № 3
Второй конкурс 2019
Объединенный экспертный совет
Объявление 14102019.pdf131 КБ
объявление о проведении в 2020 году конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Первый конкурс 2020
Рекомендации по подготовке бюджета 2020-1. pdf397 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2020 года)
Первый конкурс 2020
Форма договора 14102019.pdf221 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 14 октября 2019 года)
Первый конкурс 2020
Положение о конкурсе 14102019.pdf270 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первом в 2020 году)
Положения
Первый конкурс 2020
Шаблон заявки 2020-1.docx77 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 14 октября 2019 года)
Первый конкурс 2020
Инструкция по заполнению заявки 2020-1. pdf777 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2020 года)
Первый конкурс 2020
Протокол КК от 31052019 2.pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 31 мая 2019 года № 2
Первый конкурс 2019
Координационный комитет
Шаблон заявки 2019-2.docx76 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 10 июня 2019 года)
Второй конкурс 2019
Форма договора 01062019.pdf236 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 1 июня 2019 года)
Второй конкурс 2019
Рекомендации по подготовке бюджета 2019-2. pdf402 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2019 года)
Второй конкурс 2019
Инструкция по заполнению заявки 2019-2.pdf804 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2019 года)
Второй конкурс 2019
Положение об оценке.pdf177 КБ
Положение о порядке оценки результатов проектов победителей конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Оценка результатов
Протокол ОЭС от 24052019 2.pdf173 КБ
протокол заседания объединенного экспертного совета от 24 мая 2019 года № 2
Первый конкурс 2019
Объединенный экспертный совет
Положение о конкурсе 31052019. pdf264 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2019 году)
Положения
Второй конкурс 2019
Протокол ОЭС от 25032019 1.pdf176 КБ
протокол заседания объединенного экспертного совета от 25 марта 2019 года № 1
Объединенный экспертный совет
Первый конкурс 2019
Протокол КК от 30012019 1.pdf287 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 30 января 2019 года № 1
Координационный комитет
Первый конкурс 2019
Протокол ОЭС от 20122018 6.pdf66 КБ
протокол заседания объединенного экспертного совета от 20 декабря 2018 года № 6
Объединенный экспертный совет
Второй конкурс 2018
Порядок экспертизы 25032019. pdf132 КБ
положение о порядке проведения независимой экспертизы проектов, представленных на конкурс на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 25 марта 2019 года)
Независимая экспертиза
Инструкция по заполнению заявки 2019-1.pdf784 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2019 года)
Первый конкурс 2019
Шаблон заявки 2019-1.docx54 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 31 января 2019 года)
Первый конкурс 2019
Рекомендации по подготовке бюджета 2019-1. pdf402 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2019 года)
Первый конкурс 2019
Объявление 30012019.pdf129 КБ
объявление о проведении в 2019 году конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Первый конкурс 2019
Второй конкурс 2019
Презентация первый конкурс 2019.pdf1 МБ
презентация «Гранты Президента Российской Федерации на развитие гражданского общества: первый конкурс 2019 года»
Первый конкурс 2019
Положение о конкурсе 30012019.pdf257 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первом в 2019 году)
Положения
Первый конкурс 2019
Указ Президента Российской Федерации от 30 января 2019 года № 30 «О грантах Президента Российской Федерации, предоставляемых на развитие гражданского общества»
Конкурсная документация
Документы фонда
Решения Президента
Форма договора 30012019. pdf239 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 30 января 2019 года)
Первый конкурс 2019
Приказ от 15062020 № 10.pdf75 КБ
Приказ от 15 июня 2020 года № 10 о внесении изменений в приказы Фонда президентских грантов от 30 января 2019 года № 1, от 31 мая 2019 года № 6 и от 14 октября 2019 года № 9
Второй конкурс 2019
Первый конкурс 2020
Первый конкурс 2019
Протокол КК от 31102018 3.pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 31 октября 2018 года № 3
Координационный комитет
Второй конкурс 2018
Протокол ОЭС от 25102018 5.pdf283 КБ
протокол заседания объединенного экспертного совета от 25 октября 2018 года № 5
Объединенный экспертный совет
Второй конкурс 2018
Протокол ОЭС от 20092018 4. pdf272 КБ
протокол заседания объединенного экспертного совета от 20 сентября 2018 года № 4
Объединенный экспертный совет
Второй конкурс 2018
Инструкция 13072018.pdf891 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2018 года)
Второй конкурс 2018
Рекомендации по подготовке бюджета.pdf403 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второй конкурс 2018 года)
Второй конкурс 2018
Изменения 25062018.pdf102 КБ
основные изменения условий конкурса на предоставление грантов Президента Российской Федерации на развитие гражданского общества (второго в 2018 году)
Второй конкурс 2018
Положение о конкурсе 25062018. pdf245 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2018 году)
Положения
Второй конкурс 2018
Объявление 25062018.pdf128 КБ
объявление о проведении второго в 2018 году конкурса на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Второй конкурс 2018
Форма договора 25062018.pdf239 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 25 июня 2018 года)
Второй конкурс 2018
Шаблон заявки 13072018.doc316 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 13 июля 2018 года)
Второй конкурс 2018
Презентация 2018. pdf593 КБ
презентация 2018
Второй конкурс 2018
распоряжение Президента Российской Федерации от 3 апреля 2017 года № 93-рп (с изменением, внесенным распоряжением Президента Российской Федерации от 26 июля 2017 года № 272-рп)
Второй конкурс 2017
Первый конкурс 2017
Решения Президента
Инструкция 20022018.pdf811 КБ
инструкция (методические рекомендации) по заполнению заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2018 года)
Первый конкурс 2018
Объявление о проведении конкурсов 2017.pdf70 КБ
объявление о проведении в 2017 году конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Второй конкурс 2017
Первый конкурс 2017
Положение о конкурсе 14042017. pdf130 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первом в 2017 году)
Положения
Первый конкурс 2017
Положение о конкурсе 15082017.pdf132 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (втором в 2017 году)
Положения
Второй конкурс 2017
Объявление 19022018.pdf128 КБ
объявление о проведении в 2018 году конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Первый конкурс 2018
Требования к использованию гранта.pdf284 КБ
требования, предъявляемые Фондом президентских грантов к использованию гранта Президента Российской Федерации на развитие гражданского общества (редакция от 06 ноября 2020 года)
Методические материалы
Форма договора 19022018. pdf262 КБ
форма договора о предоставлении гранта Президента Российской Федерации на развитие гражданского общества (редакция от 19 февраля 2018 года)
Первый конкурс 2018
Положение о конкурсе 19022018.pdf244 КБ
положение о конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первом в 2018 году)
Первый конкурс 2018
Положения
Рекомендации по подготовке бюджета.pdf403 КБ
методические рекомендации по подготовке бюджета проекта в составе заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (первый конкурс 2018 года)
Первый конкурс 2018
Протокол КК от 31052018 2.pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 31 мая 2018 года № 2
Первый конкурс 2018
Координационный комитет
Протокол ОЭС от 23052018 3. pdf153 КБ
протокол заседания объединенного экспертного совета от 23 мая 2018 года № 3
Первый конкурс 2018
Объединенный экспертный совет
Протокол ОЭС от 03042018 2.pdf174 КБ
протокол заседания объединенного экспертного совета от 3 апреля 2018 года № 2
Первый конкурс 2018
Объединенный экспертный совет
Протокол КК от 15022018 1.pdf157 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 15 февраля 2018 года № 1
Координационный комитет
Первый конкурс 2018
Устав фонда.pdf2 МБ
устав Фонда президентских грантов
Документы фонда
распоряжение Президента Российской Федерации от 19 февраля 2018 г. № 32-рп
Первый конкурс 2018
Второй конкурс 2018
Решения Президента
Шаблон заявки 19022018.doc294 КБ
шаблон заявки на участие в конкурсе на предоставление грантов Президента Российской Федерации на развитие гражданского общества (редакция от 19 февраля 2018 года)
Первый конкурс 2018
Порядок обработки персональных данных.pdf138 КБ
положение о порядке обработки и защиты персональных данных
Документы фонда
Протокол ОЭС от 02022018 1.pdf69 КБ
протокол заседания объединенного экспертного совета от 2 февраля 2018 года № 1
Первый конкурс 2018
Объединенный экспертный совет
Протокол ОЭС от 20122017 7.pdf68 КБ
протокол заседания объединенного экспертного совета от 20 декабря 2017 года № 7
Объединенный экспертный совет
Протокол КК от 22112017 3. pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 22 ноября 2017 года № 3
Координационный комитет
Второй конкурс 2017
Протокол ОЭС от 14112017 6.pdf80 КБ
протокол заседания объединенного экспертного совета от 14 ноября 2017 года № 6
Объединенный экспертный совет
Протокол ОЭС от 09102017 5.pdf73 КБ
протокол заседания объединенного экспертного совета от 9 октября 2017 года № 5
Второй конкурс 2017
Объединенный экспертный совет
Протокол ОЭС от 28092017 4.pdf163 КБ
протокол заседания объединенного экспертного совета от 28 сентября 2017 года № 4
Объединенный экспертный совет
Второй конкурс 2017
Протокол КК от 31072017 2. pdf1 МБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 31 июля 2017 года № 2
Координационный комитет
Первый конкурс 2017
Протокол ОЭС от 26072017 3.pdf74 КБ
протокол заседания объединенного экспертного совета от 26 июля 2017 года № 3
Объединенный экспертный совет
Протокол ОЭС от 20072017 2.pdf81 КБ
протокол заседания объединенного экспертного совета от 20 июля 2017 года № 2
Первый конкурс 2017
Объединенный экспертный совет
Протокол ОЭС от 09062017 1.pdf166 КБ
протокол заседания объединенного экспертного совета от 9 июня 2017 года № 1
Первый конкурс 2017
Объединенный экспертный совет
Протокол КК от 12042017 1. pdf159 КБ
протокол заседания Координационного комитета по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества от 12 апреля 2017 года № 1
Координационный комитет
Первый конкурс 2017
Положение об ОЭС.pdf70 КБ
положение об объединенном экспертном совете
Объединенный экспертный совет
Положение о КК.pdf187 КБ
положение о Координационном комитете по проведению конкурсов на предоставление грантов Президента Российской Федерации на развитие гражданского общества
Координационный комитет
Решения Президента
Глава 3. ОСНОВНЫЕ ПРАВИЛА СОСТАВЛЕНИЯ ТЕКСТА ДОКУМЕНТОВ. Правила оформления документов
Похожие главы из других работ:
Анализ типового радиотехнического звена
2.
1 Основные положенияСтруктурная схема типового радиотехнического звена показана на рисунке 2.1. Рисунок 2.1 Структурная схема типового радиотехнического звена. Временные реализации случайных процессов обозначаются в соответствии с рис.2.1 буквами U, X, Y и Z…
Документация и документооборот
1. Основные этапы документооборота.
Составление и оформление документов. Чтобы документы могли служить достоверным основанием для бухгалтерских записей и иметь юридическую силу, к их состав-лению предъявляются определенные требования. Прежде всего, не-обходимо…
Использование документов Архивного фонда РФ в информационных целях
2. Основные направления использования документов
Дела кадровой службы подлежат оформлению при их заведении, при отсутствии надобности в них и по завершении календарного года…
Окрашивание волос
3.1 Правила этикета работы с клиентами
Для успешного обслуживания клиентов необходимо научиться понимать их. Для этого нужно учитывать такие черты характеров клиента, как самостоятельность и решительность, доброжелательность и придирчивость, словоохотливость и молчаливость…
Основы и правила макияжа
2. Основные правила макияжа
Взгляните на лицо как художник. Конечно, не стоит воспринимать этот совет слишком уж буквально, тем более если вы поклонница Пикассо. Однако творческий подход необходим. Необходимо определить самые привлекательные, на ваш взгляд…
Оформление бланков, официальной доверенности, гарантийных писем
Какие документы относятся к группе распорядительных документов правления. Правила и требования, предъявляемые к их оформлению
бланк доверенность гарантийный документ Распорядительными документами называют первичные документы, в которых содержатся распоряжения, указания о производстве, выполнении тех или иных хозяйственных операций (платежное поручение…
Помещение и оборудование парикмахерских салонов и их предназначение
3.
1 Правила этикета работы с клиентами…
Помещение и оборудование парикмахерских салонов и их предназначение
Правила этикета работы с клиентами.
Для успешного обслуживания клиентов необходимо научиться понимать их. Для этого нужно учитывать такие черты характеров клиента, как самостоятельность и решительность, доброжелательность и придирчивость, словоохотливость и молчаливость…
Правила оформления документов
Глава 1. ПРАВИЛА ОФОРМЛЕНИЯ ДОКУМЕНТОВ
С 1 июля 2003 г. введен новый стандарт ГОСТ Р 6.30-2003, устанавливающий требования к оформлению документов. Он интересен всем, кому приходится работать с такими документами, как постановления, распоряжения, приказы, решения, протоколы, акты…
Составление архивных описей
ГЛАВА 1. ОБЩИЕ ПОНЯТИЯ ОБ ОПИСИ И ЭТАПЫ ЕЕ СОСТАВЛЕНИЯ
Для обеспечения комплектования архива в организации на все завершенные в делопроизводстве дела постоянного, временного (свыше 10 лет) хранения и по личному составу, прошедшие экспертизу ценности, составляются архивные описи. ..
Структура аргументации: тезис, аргумент, демонстрация.
Правила аргументации по отношению к тезису.
Для того чтобы цель аргументативного процесса была достигнута, т.е. чтобы в той или иной степени была обоснована истинность или ложность тезиса, в аргументациях должны быть соблюдены некоторые логические правила…
Структура гипотезы
2. Структура гипотезы и правила формулирования гипотез
По структуре гипотезы можно разделить на простые и сложные. 1. Простые гипотезы по функциональной направленности можно классифицировать как: · Описательные — кратко резюмируют изучаемые явления, описывают общие формы их связи…
Теоретическая и практическая деятельность в области архивного дела
2.2 Основные правила работы государственных архивов РФ
Осенью 2001 года коллегия Росархива обсудила и в целом одобрила проект Основных правил работы государственных архивов РФ, подготовленный творческим коллективом из сорока специалистов Росархива, ВНИИДАТ и архивных учреждений. ..
Технические средства, упрощающие ведение делопроизводства на предприятии
2.1 СРЕДСТВА СОСТАВЛЕНИЯ И ИЗГОТОВЛЕНИЯ ДОКУМЕНТОВ
Пишущие машинки Этот недавно еще незаменимый вид конторского оборудования все более вытесняется персональными компьютерами, оснащенными принтерами…
Управлінські документи
7. Основні правила групування документів у справі
Справа — це сукупність документів, які стосуються одного питання чи ділянки діяльності й уміщені в окрему обкладинку. Формування справи — це визначення належності документів до певної справи й систематизація документів усередині справи…
Восемь правил хорошей документации — O’Reilly
Этот пост представляет собой адаптированный отрывок из книги Адама Д. Скотта «Совместная веб-разработка».
Представьте на мгновение два обычных сценария из жизни веб-разработчика.
В первом сценарии встретьтесь с Харлоу. Сегодня первый день Харлоу в новом проекте. У команды есть хорошо зарекомендовавшая себя кодовая база, отличная рабочая среда и надежный набор тестов. Когда Харлоу садится за свой стол, она взволнована тем, что может поспешить с командой.После утренней встречи она указала на проектную документацию для установки с легкой гримасой коллеги Райли. Он упоминает, что документы «могут быть немного устаревшими, но, надеюсь, их будет достаточно, чтобы вы могли начать». Затем Харлоу проводит остаток дня, изучая документацию, пока не застрянет, после чего ей приходится копаться в коде или просить помощи у коллег. То, что могло занять несколько минут, превращается в однодневное упражнение в разочаровании, подтачивая первоначальное волнение Харлоу.
Учитесь быстрее. Копать глубже. Смотрите дальше.
Во втором сценарии встретитесь с Харрисоном. Он работает над веб-приложением и находит библиотеку, которая на первый взгляд кажется невероятно полезной для его проекта. Когда он пытается интегрировать его со своей кодовой базой, он обнаруживает, что некоторые части API, похоже, не отражены в документации или даже не задокументированы. В конце концов, он отказывается от проекта в пользу другого решения.
Хотя эти сценарии могут быть немного преувеличены, я достаточно уверен, что многие из нас могут понять. Эти проблемы были в первую очередь вызваны не некачественным кодом, а плохой документацией.
Если полезная документация так важна для успеха проектов и благополучия разработчиков, почему она есть не во всех проектах? Я считаю, что ответ заключается в том, что, как и хороший код, хорошая документация сложна и требует много времени для написания.
На мой взгляд, есть восемь правил, которым мы можем следовать, чтобы создать хорошую документацию:
- Напишите привлекательную и понятную документацию
- Написание всеобъемлющей документации, подробно описывающей все аспекты проекта
- Создание документации, которую можно просмотреть
- Написать документацию с примерами использования программного обеспечения
- Напишите документацию, в которой есть повторения, когда это полезно
- Запись актуальной документации
- Напишите документацию, которую легко внести в
- Напишите документацию, которую легко найти
Наиболее важным правилом хорошей документации является ее как можно более привлекательная . Это означает, что мы должны стремиться написать его как можно яснее, не пропуская ни одного шага. Нам следует избегать предположений о том, что могут знать наши пользователи. Иногда это может показаться излишним, и у нас может возникнуть соблазн сказать что-то вроде «каждый X-разработчик знает о Y», но каждый из нас привносит в проект свой собственный опыт и опыт. Хотя это может привести к более подробной документации, в конечном итоге это проще, так как для разработчиков с любым уровнем опыта требуется меньше догадок.
Документация должна быть всеобъемлющей . Это означает, что все аспекты проекта задокументированы. Недокументированные функции или исключения могут привести к разочарованию и отнять время, поскольку пользователи и другие разработчики вынуждены читать код, чтобы найти нужные им ответы. Полное документирование всех функций устраняет подобную двусмысленность.
Когда мы пишем документацию, которую можно просмотреть , мы помогаем пользователям быстро находить нужный им контент. Сделать документацию удобной для просмотра можно с помощью четких заголовков, маркированных списков и ссылок.Для документации по большому проекту оглавление или четкая навигация помогут пользователям сразу переходить к тому, что им нужно, а не прокручивать один длинный документ.
Документация с примерами позволяет пользователям увидеть, как они сами могут использовать код. Стремитесь предоставить примеры наиболее распространенных вариантов использования для проекта, позволяя при этом подробно описать все возможности в подробной документации.
Вполне допустимо, чтобы включала некоторое повторение в документацию, которую проект Write the Docs называет «ARID» (допускает (некоторое) повторение в документации).Это означает, что пользователи могут не читать всю документацию или что некоторая информация актуальна в нескольких местах документации. В то время как хороший код может быть СУХИМ, хорошее письмо должно быть ясным, а иногда это означает повторение самих себя. Проект Write the Docs описывает разницу между ARID, DRY и WET следующим образом:
Стремление минимизировать повторение остается доблестным! СУХОЙ не означает ВЛАЖНЫЙ, отсюда и выбор слова. Это означает: постарайтесь, чтобы все было как можно СУХИМ, но также признайте, что вам неизбежно понадобится некоторое количество «влажности» для создания документации.
Действующая документация поддерживается в актуальном состоянии . Это удивительно сложно. Мы можем начать наш проект с самыми лучшими намерениями и отличной документацией, но по мере того, как наше программное обеспечение развивается и мы быстро итерируем, может быть легко отстать от него. Если вы работаете в составе гибкой команды разработчиков, я рекомендую добавить документацию в «определение готовности» вашей команды. Для независимых проектов старайтесь относиться к документации как к важному заключительному шагу.
Документацию, которую легко внести в , также легко поддерживать в актуальном состоянии. Самый простой способ сделать документацию удобной для внесения вклада — рассматривать ее как код, сохраняя ее как текст в системе управления версиями. Сайт и книга «Документы как код» пропагандируют отношение к нашим документам как к нашему коду, используя систему управления исходным кодом, автоматизируя сборки и применяя инструменты и методы разработки программного обеспечения к нашей практике документирования.
Документация полезна настолько, насколько легко найти . Хранение обновленного файла README и ссылки на более обширную документацию в верхней части README, когда это необходимо, помогают упростить обнаружение.
Я надеюсь, что эти рекомендации будут вам полезны при составлении документации вашего проекта. Иногда полезно помнить, что документация предназначена не только для других разработчиков, но часто и для нас самих в будущем. Когда мы вернемся к проекту через несколько месяцев, мы оценим работу, которую мы вложили в четкую и актуальную документацию.
Написание правил и положений — eRegulations
Обзор и контрольный список
- Следуйте стандартной структуре схемы правил.
- Добавьте любые маркированные или нумерованные списки в основную структуру документа.
- Используйте в документе встроенную структуру заголовков вашего программного обеспечения для письма.
- Используйте заголовки последовательно и везде, где это возможно.
- Изменить, пересмотреть, добавить или удалить целые абзацы.
- Ссылка на преамбулу при создании поправки и наоборот.
- Пишите на языке, понятном среднему гражданину.
1.Что такое электронные правила?
eRegulations — это платформа с открытым исходным кодом, упрощающая поиск, чтение и понимание правил. Мы оцифровываем постановления и правила агентства, чтобы представить их встроенную структуру в понятной, удобочитаемой форме, включая их изменения с течением времени.
eRegulations Notice & Comment также позволяет общественности комментировать уведомления о предлагаемом нормотворчестве структурированным и более точным образом. Это упрощает комментаторам реагирование на определенные проблемы в правиле — вплоть до уровня абзаца — и позволяет агентствам эффективно сортировать и систематизировать эти комментарии.
Вы можете узнать больше об истории, функциях и предыстории платформы eRegulations на eregs.github.io.
2. Почему этот документ важен?
2.1 Упрощение и ускорение анализа правил и уведомлений
Форматирование, описанное в этом документе, позволит платформе eRegulations без проблем принять ваше предложение или нормативный акт. Это поможет избежать дополнительной ручной работы и настройки со стороны разработчика, значительно сократив расходы вашего агентства.
2.2 Соответствие нормативным требованиям
У каждого агентства есть свои принципы и тон написания правил, но общественность разбирает правила многих агентств, чтобы сделать что-то одно. Чем больше одинаковых положений и правил в структурах агентств, тем меньше бремя понимания того, как их соблюдать. Точно так же, когда есть сомнения и когда это возможно, мы рекомендуем простой и понятный язык.
2.3 Строгое соблюдение Руководства по составлению документов Федерального реестра
Прежде всего, мы рекомендуем следовать Справочнику по составлению документов Федерального реестра.Таким образом, платформа eRegulations может улучшить данные, поступающие из Федерального реестра, и представить их в более контекстуальном и удобном для восприятия человеком формате для вашей аудитории.
3. Форматирование и структурирование правила
3.1 Формат и структура
В нормативных документах «семантика» документа относится к их , означающему , в отличие от их внешнего вида . Например, этот документ имеет два уровня заголовков. Их внешний вид включает в себя размер шрифта, вес (например, полужирный) и т. д.в то время как их семантика вращается вокруг структуры, которую они придают документу. Например, этот раздел «3.1 Формат и структура» живет внутри раздела «3. Форматирование и структурирование вашего правила». Это семантическая структура .
Платформа eRegulations ориентирована на структуру нормативных актов, уведомлений Федерального реестра и т. д. Мы знаем, как разделить документы на отдельные страницы, связать разделы, показать исторические изменения нормативных актов с течением времени и т. д. благодаря пониманию структура документов.Использование и добавление уровня форматирования к осмысленным заголовкам и подзаголовкам упрощает синтаксический анализ и организацию правил для платформы eRegulations, а также для чтения людьми.
Мы рекомендуем вам избегать ссылок на конкретные детали форматирования (например, «см. текст, выделенный курсивом/подчеркнутым/жирным шрифтом в параграфе (b)»), так как окончательное представление может не отображать их одинаково во всех версии вашего правила и вместо этого сосредоточьтесь на семантической структуре .
Точно так же имейте в виду, что «идеальное» правило (и правило, которое печатается) состоит из заголовков, абзацев, изображений и таблиц. Существует ограниченная поддержка маркированных списков, вложенных абзацев, выделенного текста (и аналогичных деталей типографского форматирования), различных типов отступов и т. д.
Сосредоточив внимание на семантической структуре вместо типографского форматирования и ограничив правило заголовками, абзацами, изображениями и таблицами, вы гарантируете, что правило будет отображаться последовательно в печатных изданиях, в федеральном реестре.gov и электронное регулирование.
3.2 Форматы файлов, принятые электронными правилами
eRegulations использует XML-данные Федерального реестра для отображения опубликованных правил и положений вашего агентства.
Если вы хотите использовать eRegulations для периода уведомления и комментирования вашего правила или хотите опубликовать документ до того, как он будет опубликован в Федеральном реестре, мы рекомендуем следующие типы файлов в порядке предпочтения:
- Идеально
- XML, написанный на
- Определение типа документа (DTD) или
- Формат, написанный с учетом стандартов Федерального реестра (т.е. использование заголовков, абзацев, таблиц и изображений, а не большого количества маркеров, отступов и других стилей и форматирования)
- Уценка HTML
- XML, написанный на
- Реально
- Microsoft Word (.doc или .docx)
- Использование встроенной структуры заголовков Word в документе.
- Microsoft Word (.doc или .docx)
3.3 Структура
Платформа eRegulations извлекает структуру правил и преамбул, чтобы представить текст в легко читаемом формате.Этот формат позволяет пользователям быстро просматривать и находить абзацы, которые относятся к ним. Правильное построение этой структуры важно, поскольку она позволяет пользователям ссылаться на определенные цитаты и комментировать определенные абзацы.
3.3.1 Структура регламента
Пожалуйста, следуйте рекомендуемой структуре Свода федеральных правил:
Название: Широкая предметная область правил
Глава: Правила индивидуального агентства
Часть: Правила для одной программы [Это «положение» на платформе eRegulations.]
Раздел: Одно положение правил программы/функции [Основной уровень навигации в электронных Регламентах.]
Пункт: Подробные, специальные требования
Электронные правилав первую очередь касаются частей, разделов и параграфов. Федеральный реестр допускает 6 уровней пунктов:
- Уровень 1: (a), (b), (c) и т. д. § 303.1(a)
- Уровень 2: (1), (2), (3) и т. д.§ 303.1(а)(1)
- Уровень 3: (i), (ii), (iii) и т. д. § 303.1(a)(1)(i)
[ Хотя и можно пройти дальше этого пункта, Федеральный реестр рекомендует никогда не углубляться более чем на три уровня. Федеральный реестр говорит о преимуществах ограничения количества пунктов. ]
- Уровень 4: (A), (B), (C) и т. д. § 303.1(a)(1)(i)(A)
- Уровень 5: (1) , (2) , (3) и т. д.§ 303.1(a)(1)(i)(A) (1) [курсив]
- Уровень 6: (i) , (ii) , (iii) и т. д. § 303.1(a)(1)(i)(A) (1)(i) [ курсив]
3.3.2 Придерживаться контурной структуры
Набросок структуры регламента — лучший друг читателя. Это создает иерархические отношения между абзацами и, следовательно, темами, позволяя читателю легче сосредоточить свою энергию на разделах, которые относятся к ним.
Структура схемы также способствует лучшему цитированию. Когда параграфы являются «адресными», на них могут ссылаться другие параграфы, уведомления и документы. Если абзац не вписывается в структуру, на него нелегко ссылаться, что затрудняет поиск пользователями. Кроме того, платформа eRegulations позволяет читателям напрямую ссылаться на разделы или параграфы.
Мы рекомендуем очень точно придерживаться структуры контура регламента (или любой другой структуры контура, которую вы используете для своей преамбулы).
Будьте осторожны при использовании нумерованных списков
Пожалуйста, не используйте нумерованные списки, которые не соответствуют структуре вашего плана. Поскольку план уже имеет иерархическую структуру, нумерованные списки легко вписываются в эту структуру. Это поддерживает поток для читателей, в то же время сообщая характер вашего списка 1, 2, 3. Хотя ваше программное обеспечение для составления чертежей позволит вам добавить в документ нумерованный список, платформа eRegulations не сможет правильно его извлечь, потому что номера будут выглядеть как цитаты на уровне абзаца.Мы хотим, чтобы ссылки работали должным образом, чтобы читатели лучше понимали, где они находятся в документе, и как указать кому-то еще, где искать.
Используйте пули экономно
Bullets отлично подходит для разбиения абзацев и уточнения текста таким образом, чтобы его было легче понять визуально. Однако в печатной версии документа Федерального реестра маркеры рассматриваются не иначе, как в любом другом абзаце. Например:
Платформа eRegulations в настоящее время следует той же схеме, что и печатный документ Федерального реестра.Мы работаем над тем, чтобы вытащить маркеры в будущем, но если ваши маркеры могут быть аналогичным образом переданы в структуре плана (как обсуждалось выше в отношении нумерованных списков), , мы рекомендуем включить эти абзацы в эту структуру.
Кроме того, мы рекомендуем не использовать подпункты. Поскольку маркеры обрабатываются так же, как и любой другой абзац, им очень трудно следовать в печатной версии документа и, следовательно, в электронных правилах. Иерархическая структура убрана.Если в вашем маркере есть вложенные маркеры, рассмотрите другую структуру, которая вмещает только один уровень маркеров или встраивает ваш список в более крупную структуру вашего документа.
Один список за раз
Чтобы правильно придерживаться структуры схемы документа, избегайте более одного списка на уровне абзаца. Например:
Хотя читатель может видеть, какой список относится к какому параграфу, платформа eRegulations не может сказать, когда заканчивается один список и начинается следующий.Мы рекомендуем изменить приведенное выше на что-то более структурированное, чтобы и платформе, и читателям было легче следить за вашим текстом:
.3.3.3 По возможности используйте заголовки
Справочник по составлению документов Федерального реестра рекомендует использовать согласованные заголовки на любом уровне абзаца. Заголовки необходимы для хорошего структурированного положения или преамбулы. Заголовки группируют и объясняют темы для публики, чтобы они знали, какие абзацы следует читать, а какие к ним не относятся.Заголовки — причина, по которой eRegulations способствует быстрому беглому просмотру и навигации по всему документу.
В справочнике Федерального реестра говорится: «Представьте эту информацию на языке, который читатель может легко понять, с описательными заголовками, чтобы выделить и упорядочить темы». Вот хороший пример того, как это может работать и выглядеть на платформе eRegulations:
Мы понимаем, что не всегда возможно иметь заголовки на уровне каждого абзаца.Однако Справочник Федерального реестра предупреждает: : «Будьте последовательны. Если вы используете заголовок для одного абзаца, обязательно используйте заголовок для всех абзацев на этом уровне». Вот несколько хороших примеров того, как это может работать на платформе eRegulations:
3.3.4 Структура преамбулы
Уведомления Федерального реестране имеют такой определенной структуры, как правила. Тем не менее, хорошая и легко читаемая преамбула в Уведомлении о предлагаемом нормотворчестве должна следовать приведенной выше структуре и заголовкам.
Хотя параграфы преамбулы имеют немного более свободную форму, чем параграфы регламента, структура чрезвычайно важна для понимания общественностью того, что агентство хочет прокомментировать. Вот хороший пример того, как это может выглядеть на платформе eRegulations:
Это правило следует этому образцу во всем. Как вы можете видеть в оглавлении. В этой преамбуле как можно чаще используются вопросы в качестве заголовков. Кроме того, они отделяют справочные абзацы от абзацев о том, что предлагает текущее правило.
4. Изменение текста регламента
4.1 Язык описания изменений
«Для обширных изменений пересматривайте текст полностью, а не подготавливайте фрагментарные поправки. То тогда читатель будет иметь полный текст измененной единицы». — Глава 1.13 Справочника по составлению документов Федерального реестра
Цель инструмента сравнения eRegulations — показать, как правила менялись с течением времени или как они изменятся в будущем.Мы можем автоматизировать этот процесс, следуя рекомендациям Федерального реестра, изложенным в их Справочнике. Однако компьютерам труднее понять определенные команды, чем людям. Следование приведенным ниже рекомендациям сэкономит вам время на разработку вашего экземпляра eRegulations и поможет дать читателям больше информации об изменениях, которые вы пытаетесь внести.
4.1.1 Исправить весь абзац по умолчанию
Даже если вы редактируете только слово или предложение, мы рекомендуем пересмотреть весь абзац .Компьютер легко сможет сравнить новый текст со старым текстом и показать различия на платформе eRegulations. Что-то вроде «изменить пятое слово в абзаце (b)» сложно для компьютеров, и может потребоваться ручное вмешательство разработчика электронных правил.
Вот один пример изменения, которое трудно разобрать: «В § 478.72 добавить новое пятое предложение следующего содержания:» На первый взгляд это кажется простой инструкцией, но что она на самом деле означает? Это может быть фраза «вставьте это предложение и сдвиньте все вниз» или «замените пятое предложение»? Это также может означать «добавить новое предложение в конец абзаца».” Отображение полностью исправленного абзаца добавляет контекст как для компьютера, анализирующего ваши правила, так и для тех ваших читателей, которые просматривают печатное правило.
4.1.2 Использование определенных ключевых слов
Платформа eRegulations очень точно следует конкретным поправочным условиям Федерального реестра (глава 1.13), чтобы провести сравнение между старым и новым регулированием. Мы рекомендуем следовать этим рекомендациям и использовать такие слова, как «пересмотреть», «добавить», «удалить», а не «изменить», «создать», «удалить» и т. д.при изменении текста регламента в уведомлении о предлагаемом нормотворчестве.
Ниже приведен список слов из руководств Федерального реестра, которые распознает платформа eRegulations. Платформа eRegulations в настоящее время не распознает зачеркнутые слова. Если вы используете одно из этих слов, это потребует ручного вмешательства разработчика электронных правил.
- Добавить, Добавлено, Добавлено
- Переназначить, переназначить, переназначить
- Удалить, Удалено, Удаление
-
Повторная публикация,Повторная публикация,Повторная публикация - Резерв,
Резерв, Резерв - Пересмотреть, Пересмотреть, Пересмотреть
-
Изъятие,Изъятие,Изъятие
4.1.3 Примеры
В хорошем состоянии: «Раздел 262.24 изменен путем пересмотра параграфов (c) и (g) следующим образом:»
Почему:
- Контекст: «Раздел 262.24» расположен спереди и по центру
- Понятно, какие абзацы редактируются
- Изменяются целые абзацы
- Использование слова «пересмотр»
В хорошем состоянии: «Добавлен подраздел FF следующего содержания:»
Почему:
- Очистить изменяемый объект (здесь — подраздел)
- Использование «добавлено»
Плохо: «Заменить пятое слово в восьмом абзаце на «cromulent»»
Почему:
- Сложно определить контекст — нужно считать абзацы вручную
- Автоматический подсчет слов еще сложнее
- Написание фраз оставляет место для интерпретации (подумайте о пробелах, расстановке запятых и т. д.).)
4.2 Перекрестные ссылки из преамбулы
Одной из самых больших проблем для читателей предлагаемого правила являются точки связи между тем, где изменение обсуждается в преамбуле, и фактической новой формулировкой. В нашем исследовании пользователей многие читатели просили об этой функции, но платформа eRegulations не может установить соединение автоматически, если в документ не вписаны правильные цитаты.
При обсуждении причин, по которым ваше агентство вносит конкретное изменение в нормативный акт, , мы рекомендуем ссылаться на изменяемую цитату в дополнение к пронумерованной поправке в уведомлении .Например:
«Регулятивные требования для [этого нового пункта] предложены в § 264.71(b) в поправке 10 к этому предлагаемому правилу».
При изменении нормативного текста в предлагаемом вами правиле, , мы рекомендуем ссылаться на раздел преамбулы, где вы обсуждаете, почему вы вносите изменение в свои инструкции . Например:
«10. Как обсуждалось в Разделе III.A.3 этого предлагаемого правила, в § 271.12 вносятся поправки путем добавления параграфа (k) следующего содержания:»
5.Преимущества простого языка
5.1 Выигрывают все
«Удобочитаемые правила помогают общественности быстро находить требования и легко их понимать. Они повышают соответствие требованиям, усиливают правоприменение и уменьшают количество ошибок, разочарований, телефонных звонков, апелляций и недоверия к правительству. Выигрывают все. » — Часть II Обеспечение удобочитаемости правил, Справочник по составлению документов Федерального реестра
Постановления правительства США предназначены для всех.Поэтому содержание, которое они содержат, должно быть максимально простым и ясным.
Мы рекомендуем избегать формальных или длинных слов, когда можно использовать простые или короткие. Например, используйте купить вместо купить , помочь вместо помочь , примерно вместо примерно и так далее.
Мы теряем доверие и понимание читателя, если пишем длинным, запутанным, «казенным» языком. Мы также снижаем уровень соблюдения нормативных требований и делаем больше телефонных звонков и запросов сотрудникам агентств, когда читатели не могут понять нормативные акты или юридические рекомендации при первом чтении.
5.2 Это закон
Закон о простом языке от 2010 года гласит, с нашим акцентом, следующее:
(2) ПОКРЫТЫЙ ДОКУМЕНТ. —Термин «покрываемый документ»—
(А) означает любой документ, который—
(i) необходимо для получения каких-либо льгот или услуг федерального правительства или для подачи налогов;
(ii) предоставляет информацию о любых льготах или услугах федерального правительства; или
(iii) разъясняет общественности, как выполнить требование, которое администрирует или обеспечивает соблюдение федеральным правительством;
(B) включает (в бумажной или электронной форме) письмо, публикацию, форму, уведомление или инструкцию; и
(C) не содержит правил.
(3) ПРОСТОЙ ПИСЬМО.— Термин «простой текст» означает письмо, которое является ясным, кратким, хорошо организованным и соответствует другим передовым методам, соответствующим предмету или области и целевой аудитории».
Этот закон применяется к преамбуле уведомлений Федерального реестра, , которые объясняют, как и почему пользователи должны соблюдать новые правила.
Хотя этот закон не применяется непосредственно к нормативным актам, существуют три исполнительных указа (E.O. 12866, E.О. 12988 и Е.О. 13563), которые способствуют использованию простого языка в правилах. И преимущества применения простого языка к тексту регламента (поскольку он меняется с течением времени) могут быть измерены с точки зрения соблюдения отраслевых требований и времени, затрачиваемого сотрудниками агентства на ответы на запросы.
Если вы заинтересованы в преимуществах и истории руководства простым языком для правил, на сайте plainlanguage.gov есть хорошее объяснение.
5.3 Несколько советов и ресурсов
Составление юридических документов, принципы четкого письма
Главная | предыдущий | Далее
Принципы четкого письма
1. Напишите в активном залоге . Активный залог устраняет путаницу, заставляя вас называть актера в предложении. Эта конструкция дает понять читателю , кто должен выполнять обязанности.
Пассивный залог делает предложения более длинными и закругленными. Кто несет ответственность, гораздо менее очевидно. Пассивные глаголы имеют форму глагола to be плюс причастие прошедшего времени основного глагола.
плюс
Примеры пассивных глаголов:
- получено,
- рассматривается,
- был выбран.
Пассивный залог меняет естественный активный порядок английских предложений. В следующем пассивном примере получатель действия предшествует действующему.
Пассивный залог: Постановление [получатель] было написано [глагол] составителем [действующим лицом].
Активный: Составитель [актер] написал [глагол] регламент [получатель].
Пассивные конструкции сбивают с толку при использовании в правилах. В активных предложениях обязательно должны быть действующие лица, а в пассивных без них не обойтись.
Помещение актера перед глаголом заставляет вас четко понимать ответственность.
- Посланник доставит материал.
- Подрядчик определит дату начала.
- Администратор должен утвердить цифры.
Пассивный залог уместен, когда действующее лицо неизвестно, неважно или очевидно. Это обычно не применяется в нормативном тексте.
- Мелкие предметы часто крадут.
- Заявки отправлены по почте.
2. Используйте глаголы действия .
Избегайте таких слов:
Они называются «номиналы» — существительные с глаголами внутри. Их трудно читать, и они удлиняют предложения. Глаголы действия короче и более прямые.
3. Используйте «должен» вместо «должен» .
Чтобы наложить юридическое обязательство, используйте «должен».
Чтобы предсказать будущее действие, используйте «will.»
НЕ ГОВОРИТЬ : Губернатор должен одобрить.
ГОВОРИТЬ: Губернатор должен одобрить. [обязательство]
ИЛИ : Губернатор одобрит. Будьте прямолинейны Говорите прямо со своими читателями Используйте повелительное наклонение Правила подходят для этого стиля, особенно процедуры, практические инструкции и списки обязанностей
Прямота избегает пассивного залога:
ГОВОРИТЬ : Подпишите все копии.
ПРОИЗНЕСИТЕ : Приложите копию формы W-2 к декларации.
В результате процедуры становятся короче, четче и понятнее.
5. Используйте настоящее время . Постановление, имеющее продолжающееся действие, действует с момента его применения, а не с момента его составления или вступления в силу. По этой причине вы должны составлять нормативные акты в настоящем времени. Составляя текст в настоящем времени, вы избегаете сложных и неудобных глагольных форм.
НЕ ГОВОРИТЕ : Штраф за вождение без прав составит 10 долларов.
ПРОИЗНЕСИТЕ : Штраф за вождение без прав составляет 10 долларов США.
6. Пишите положительно . Если вы можете точно выразить идею положительно или отрицательно, выразите ее положительно.
НЕ ГОВОРИТЕ : Губернатор не может назначать лиц, кроме квалифицированных Агентством по управлению персоналом.
ПРОИЗНЕСИТЕ : Губернатор должен назначить лицо, квалифицированное Агентством по управлению персоналом.
Отрицательное утверждение может быть ясным. Используйте его, если вы предупреждаете читателя.
НЕ ХОДИТЕ
НЕ КУРИТЕ
Но избегайте нескольких отрицаний в одном предложении.
НЕ ГОВОРИТЕ : Демонстрационный проект не будет утвержден, если не будут выполнены все требования заявки.
ПРОИЗНЕСИТЕ: Демонстрационный проект будет одобрен только в том случае, если заявитель соответствует всем требованиям.
Даже негатив лучше выражать в позитивной форме.
7. Избегайте использования исключений . Если возможно, укажите правило или категорию напрямую, а не описывайте это правило или категорию, указывая их исключения.
НЕ ГОВОРИТЬ : Все лица, кроме лиц в возрасте 18 лет и старше, должны… длинный и громоздкий список или подробное описание. Когда вы используете исключение, сначала укажите правило или категорию, а затем укажите его исключение.
НЕ ГОВОРИТЬ : Алабама, Аляска,… и Вайоминг (список из 47 штатов) должны нормировать…
ГОВОРИТЬ : Все штаты, кроме Техаса, Нью-Мексико и Аризоны, должны нормировать.. (Обратите внимание, что сначала устанавливается категория «каждый штат», а затем указываются исключения.)
8. Избегайте раздельных инфинитивов . Разделение инфинитива оскорбляет многих читателей, поэтому по возможности избегайте его.
НЕ ГОВОРИТЕ : Немедленно ответьте на приглашение.
ПРОИЗНЕСИТЕ: Обязательно ответьте как можно скорее на приглашение. или ПРОИЗНЕСИТЕ: Обязательно ответьте на приглашение как можно скорее .
9. Используйте существительное в единственном числе, а не во множественном числе . Насколько позволяет ваше значение, используйте существительное в единственном числе вместо существительного во множественном числе. Вы избежите проблемы, связанной с тем, применяется ли правило отдельно к каждому члену класса или совместно ко всему классу.
НЕ ГОВОРИТЕ : Охранник выдаст удостоверения безопасности сотрудникам, работающим в Здании D и Здании Е.
ПРОИЗНЕСИТЕ: Охранник выдаст пропуск каждому сотруднику, работающему в здании D, и каждому сотруднику, работающему в здании E.
, если вы не имеете в виду
как в здании D, так и в здании E. (Есть и другие возможные значения.)
10. Будьте последовательны. Не используйте разные слова для обозначения одних и тех же вещей . Вариации ради вариаций неуместны в написании нормативных актов.Использование синонима вместо повторения точного термина, который вы имеете в виду, только сбивает читателя с толку.
НЕ ГОВОРИТЕ : Каждый владелец автомобиля должен зарегистрировать свой автомобиль в Отделе автомобилей Департамента столичной полиции.
ПРОИЗНЕСИТЕ : Каждый владелец автомобиля должен зарегистрировать свой автомобиль в Отделе автомобилей Департамента столичной полиции.
Не используйте одно и то же слово для обозначения разных вещей.
НЕ ГОВОРИТЕ : Бак имел 200-галлонный бак для топлива.
ПРОИЗНЕСИТЕ : В баке был топливный бак на 200 галлонов.
11. Использовать параллельную структуру . Расположите предложения так, чтобы параллельные мысли выглядели параллельными. Это важно, когда вы используете список.
Непараллельная конструкция :
Обязанности Ответственного секретаря Административного комитета:
- Вести протоколы всех собраний; ( фраза )
- Ответственный секретарь отвечает на всю корреспонденцию; и ( пункт )
- Написание ежемесячных отчетов.( тема )
Параллельная конструкция :
- Вести протоколы всех собраний;
- Отвечать на всю корреспонденцию; и
- Для написания ежемесячных отчетов.
12. Предпочитаю простые слова . Правительственные письма должны быть достойными, но не должны быть напыщенными. Писать можно достойно, когда язык простой, прямой и сильный. Чтобы сделать ваше письмо более ясным и легким для чтения, а значит, и более эффективным, отдайте предпочтение простому слову.
13. Опустить лишние слова . Не используйте составные предлоги и другие многословные выражения, когда одно и то же значение можно передать одним или двумя словами.
14. Избегайте избыточности . Не используйте пары слов, если слова имеют одинаковый эффект или когда значение одного включает в себя другое.
Примеры: пары слов, которых следует избегать
15. Используйте конкретные слова . Правительственные письма часто касаются абстрактных тем. Но абстрактные слова могут быть расплывчатыми и открытыми для различных интерпретаций.Излагайте инструкции простыми, конкретными словами.
16. Не используйте слова, которые враждебны . Слова могут привлекать или отталкивать читателей. В нашем письме можно выбирать слова, которые не производят неправильного впечатления и не раздражают наших читателей. Используйте слова, на которые люди реагируют положительно, а не слова, на которые они возмущаются.
17. Избегайте бутербродов с существительными . В административном письме используется слишком много кластеров существительных — групп существительных, «зажатых» вместе.Избегайте этих запутанных конструкций, используя больше предлогов.
НЕ ГОВОРИТЕ: Разработка правил техники безопасности для горняков.
SAY: Разработка подземных процедур по защите безопасности горняков.
ИЛИ БОЛЕЕ ВЕРОЯТНО: Разработка процедур по защите безопасности рабочих в подземных шахтах.
Какое значение имеется в виду, станет яснее, если разобрать этот сэндвич из четырех слов.
18. Не используйте гендерную терминологию . Избегайте названий должностей, зависящих от пола:
.Избегайте местоимений, определяющих пол, когда антецедент может быть мужским или женским.
НЕ ГОВОРИТЕ: Администратор или его представитель должны заполнить форму оценки.
SAY: Администратор или представитель администратора должен заполнить форму оценки.
Будьте осторожны при перезаписи, чтобы избежать проблемы. Следующие примеры не обязательно имеют одно и то же значение —
- Каждый региональный директор объявит свои рекомендации на конференции.
- Региональные директора объявят свои рекомендации на конференции.
19. Пишите короткие предложения . Читаемые предложения простые, активные, утвердительные и повествовательные.
Чем больше предложение отклоняется от этой структуры, тем сложнее его понять.
Длинные, повторяющиеся предложения — основной недостаток юридических документов.
Юридические документы часто содержат условия, которые приводят к сложным предложениям со многими пунктами.
Чем сложнее предложение, тем больше вероятность возникновения трудностей при определении предполагаемого значения предложения.
Решения
- Назовите одну и только одну вещь в каждом предложении.
- Разделите длинные предложения на два или три коротких предложения.
- Удалите все ненужные слова. Стремитесь к простому предложению с подлежащим и глаголом. Удалите ненужные модификаторы.
- Если для применения правила необходимо выполнить только одно или два простых условия, сначала укажите условия, а затем правило.
- Если для применения правила необходимо выполнить два или более сложных условия, сначала укажите правило, а затем условия.
- Если для применения правила необходимо выполнить несколько условий или подчиненных положений, используйте список.
20. Сделайте списки понятными и логичными по структуре . В листинге есть пробелы, разделяющие различные условия. Список может помочь вам избежать проблем двусмысленности, вызванных словами «и» и «или».При составлении списка используйте следующие правила:
- Использовать параллельную структуру. (См. пример в пункте 11 выше.)
- Перечислите каждый элемент так, чтобы он создавал законченную мысль при чтении с вступительным текстом.
- Если вводным языком для списка является полное предложение —
- Завершите введение двоеточием; и
- Сделать каждый элемент в списке отдельным предложением.
- Если вводный язык для списка является неполным предложением —
- Завершите введение тире;
- Завершайте каждый элемент списка, кроме последнего, точкой с запятой;
- После точки с запятой в предпоследнем элементе списка напишите «и» или «или» в зависимости от ситуации; и
- Завершите последний элемент списка точкой.
21. Используйте короткие абзацы . Автор может улучшить ясность правила, используя короткие компактные абзацы. Каждый абзац должен касаться одной единой темы. Длинные, сложные или технические обсуждения должны быть представлены в виде ряда связанных абзацев.
22. Используйте контрольный список и просмотрите свой проект по каждому из этих принципов отдельно.
Предыдущий | Далее
Написание документов, шаг за шагом (с шаблонами)
Работаете ли вы в мире бизнеса уже много лет или только начинаете свою академическую карьеру, написание документа может быть пугающим.Но не беспокойтесь: если вы смотрели на пустую страницу, не зная, с чего начать, вы попали в нужное место. Это пошаговое руководство поможет вам с уверенностью справиться с любым письменным проектом, поэтому читайте дальше, чтобы узнать, как это работает.
Что такое написание документов?
Оксфордские словари определяют документ как «часть письменного, печатного или электронного материала, который предоставляет информацию или доказательства или служит официальной записью». Написание документа Таким образом, это процесс создания письменного документа.Звучит просто, правда? Ведь все мы учимся писать в школе, и все мы знаем, как открыть текстовый документ на своем компьютере.
Но если бы все было так просто, вы бы сейчас не читали эту статью.
Что делает написание документов таким трудным?
Пустая страница — враг любого писателя. Даже профессионалы иногда часами смотрят на этот мигающий курсор в верхнем левом углу. Вопреки распространенному мнению, свобода, которую предлагает пустой документ, не способствует творчеству — она пугает .Есть тысяча способов подойти к любой теме, миллион способов сформулировать первое предложение. В результате многие из нас страдают от того, что называется чрезмерным выбором или переизбытком выбора .
Пустой документ рассчитан на линейных текстов и поэтому вынуждает вас писать именно это: связный, линейный текст с началом, серединой и концом. Он просит вас прыгать и создавать полные предложения, которые имеют смысл и логически связаны с предложениями, которые идут до и после них.Даже если вы хорошо знакомы с предметом, начинать писательский проект таким образом сложно.
Так что же вы можете сделать вместо этого?
Легко. Уберите пустую страницу, и вы уберете давление. Идите вперед и закройте свой документ Word — он вам сейчас не нужен.
Ваша первая цель — не написать идеальный текст. Ваша первая цель — понять, что вы пытаетесь сказать . Письмо приходит позже; совершенство приходит еще позже.
Ниже мы описали пять шагов, которые помогут вам создать документ . Вам не нужно выполнять эти шаги до буквы T каждый раз, когда вы начинаете писать проект, и вам не обязательно выполнять их в этом порядке. Планирование, исследование, мозговой штурм и наброски вашего документа не обязательно являются отдельными этапами. Это нормально — прыгать между ними, записывать новые идеи по мере их появления и возвращаться назад и проводить дополнительные исследования, если это необходимо.
Как написать документ, шаг за шагом:
Шаг 1. Планирование документа
Как и любой другой проект, письменный проект требует некоторого планирования .Начните с определения области документа — какую информацию он должен включать, а какую можно (и нужно) исключить. Масштаб определяется назначением документа и его аудиторией (также известной как ваша целевая аудитория).
Читательская аудитория
Задайте себе следующие вопросы о своих читателях:
- Насколько знакомы мои читатели с темой, которую я собираюсь обсудить?
- Каковы демографические демографические данные моей читательской аудитории — сколько им лет, на каком языке они говорят и каков их уровень образования?
Например, если вы программист и пишете документацию для коллег с таким же уровнем знаний, ваш текст не должен включать определения общепринятых терминов.Однако, если вы пишете документацию для начального класса старшеклассников, изучающих программирование, в вашем документе может потребоваться гораздо больше деталей и объяснений.
Назначение
Не менее важно определить цель документа. Это может быть одно из следующих:
- Предоставить информацию
- Дайте инструкции
- Предлагайте идеи / убеждайте читателя
- Поделитесь своим мнением
Стиль и тон
Знание демографических характеристик вашей читательской аудитории и цели вашего документа также поможет вам выбрать наиболее подходящий стиль и тон.Если вы отправляете бизнес-план потенциальному инвестору, тон вашего документа, вероятно, должен будет сильно отличаться от того, который вы использовали бы при написании руководства по выживанию для родителей-новичков . Последнее может быть уместно для небольшого сарказма, в то время как любой вид юмора, вероятно, неуместен в первом.
Итак, прежде чем приступить к написанию, подумайте, каким должен быть ваш тон:
- формальный или неформальный
- личное или безличное
- серьезный или юмористический.
Дикция
Затем подумайте над дикцией, а также выбором слов . В то время как ваш бизнес-план должен использовать формальную лексику , вы можете поменьше использовать жаргон , если только инвестор, которому вы подаете заявку, не знаком с вашей конкретной нишей бизнеса. С другой стороны, с руководством по выживанию родителей-новичков вы, вероятно, захотите обратиться к относительно молодой аудитории. Таким образом, включение отсылок к поп-культуре и разговорных выражений может на самом деле улучшить впечатления читателя.
Длина предложения
Длина и сложность предложений также должны быть адаптированы к вашей аудитории. Всегда важно быть ясным и кратким . Однако некоторые целевые аудитории, например ученые, более терпимы к длинным предложениям, чем, скажем, занятый руководитель.
Вы можете использовать бесплатный шаблон ментальной карты ниже, чтобы спланировать свой документ . Просто скопируйте интеллект-карту в свою учетную запись MindMeister и заполните ее. Вы можете использовать карту в качестве справочника на протяжении всего процесса написания и редактирования.
У вас еще нет учетной записи MindMeister? Вы можете зарегистрироваться бесплатно здесь.
Шаг 2: исследование и мозговой штурм
Теперь, когда вы определились с масштабом и стилем вашего документа, пришло время провести исследование . Хотя вы, безусловно, можете использовать текстовый документ для сбора всех цитат, ссылок, фактов и других ссылок, которые вы хотите включить, линейный формат не идеален для этой цели.
Классический формат интеллект-карт, популяризированный английским исследователем Тони Бьюзеном в 70-х годах, отлично подходит для визуализации того, как связаны между собой отдельные фрагменты информации.Используя интеллект-карту, вы можете собрать все свои заметки, идеи и ссылки на одной странице . Цифровые интеллект-карты особенно практичны, поскольку они позволяют перемещать элементов вокруг , чтобы сгруппировать их так, как это имеет смысл.
Помимо ссылок, цифровые интеллект-карты также предлагают место для мультимедийных вложений , таких как изображения, видео и целые файлы, так что вы можете сопоставлять все свои исследования в одном месте.
Чтобы начать работу, просто откройте новую интеллект-карту, напишите название своего документа в центре карты и добавьте свои примечания.
Хотите узнать больше о том, как эффективно проводить мозговой штурм? Ознакомьтесь с нашей статьей об онлайн-мозговом штурме с интеллект-картами. У нас также есть руководство о том, как создавать ценный контент с помощью MindMeister и Kindle.
Шаг 3. Определение структуры документа
Структура вашего текста во многом определяется типом документа, который вы пишете. Ниже приведен далеко не исчерпывающий список типов документов, с которыми вы можете столкнуться:
.Академические документы:
- Диссертация
- Бумага
- Журнал
- Аргументативное эссе
- Исследовательское предложение
Деловые документы:
- Контракт
- Отчет
- Бизнес-план
- Финансовый отчет
- Руководство пользователя
- Проектная документация
- Белая бумага
Давайте подробнее рассмотрим три разных вида документов и сравним их отдельные структуры:
Аргументативное эссе:
Аргументативные эссе часто следуют подходу из 5 абзацев.Нижеприведенный шаблон интеллект-карты описывает эти 5 абзацев — если вам нужно написать аргументированное эссе, вы можете использовать этот шаблон в качестве отправной точки:
Бизнес-план:
Типичный бизнес-план содержит шесть важных элементов, которые представлены в приведенном ниже шаблоне карты. Вы можете скопировать этот шаблон карты в свою бесплатную учетную запись MindMeister, чтобы заполнить его:
Исследовательское предложение:
Если вы подаете заявку на получение исследовательской степени, вам необходимо подать исследовательское предложение.В приведенном ниже шаблоне указаны ключевые элементы, которые должны содержаться в таком документе.
Как видно из трех приведенных выше шаблонов, для каждого документа требуется своя структура. Конечно, эти структуры не высечены на камне — они основаны на условностях. Вы всегда можете адаптировать их под свои нужды .
Шаг 4. Создание документа
Теперь, когда вы создали логическую структуру для своего документа и выполнили все исследования, наконец пришло время приступить к фактическому процессу написания .
Если вы использовали MindMeister для наброска своего документа, вы можете полностью отказаться от пугающей пустой страницы, экспортировав содержимое карты в виде текстового наброска в Microsoft Word. Теперь все, что вам нужно сделать, это конкретизировать свой план , добавив информацию, которую вы собрали в своей исследовательской интеллект-карте.
ОднакоMicrosoft Word — не единственная программа для письма в городе. В зависимости от того, какой документ вы пишете, вам может быть лучше использовать другой инструмент. Ниже приведен список популярных инструментов для письма, которые могут лучше подойти для ваших нужд.Что бы вы ни выбрали, хорошая проверка грамматики и орфографии обязательна.
Классика:
Программное обеспечение для написания документов:
Программное обеспечение общего назначения:
Средства управления знаниями:
Средства документирования кода:
Шаг 5. Редактирование документа
Если вы думаете, что закончили, как только написали последнее предложение в документе, подумайте еще раз. Важность редактирования невозможно переоценить.Или, как выразился великий писатель Эрнест Хемингуэй:
.Первый набросок всего дерьмо.
Хотя вы, возможно, очень хотите, наконец, отправить документ и перейти к другим задачам, вы никогда не должны делать этого, пока не просмотрите свой текст в последний раз. Для достижения наилучших результатов оставьте документ в покое как минимум на 24 часа — дольше, если это возможно. Взглянув на него свежим взглядом, вы значительно повысите свои шансы обнаружить ошибки и другие проблемы.
Если вы не использовали такой инструмент, как приложение Hemingway, в процессе написания, рассмотрите возможность вставки содержимого вашего документа в это приложение сейчас.Приложение Hemingway было разработано, чтобы «сделать ваше письмо смелым и ясным», как всегда рекомендовал сам Эрнест Хемингуэй. Приложение выделяет длинные и сложные предложения и указывает на ослабляющие фразы.
Даже если писательство не является вашей настоящей страстью, при правильном планировании и подходящих инструментах вам больше никогда не придется бояться пустой страницы. Поэтому, когда вы будете готовы приступить к работе над своим следующим документом, просто выполните пять шагов, описанных в этой статье, и вы увидите, как быстро все получится.
Руководство для начинающих по написанию документации — Write the Docs
Сцена выше хорошо известна всем, кто пишет для жизни; смешанные эмоции пустой страницы. Полный волнения, свежий с новым началом. Но в то же время полный отчаяния, с чего же начать?
Я здесь, чтобы не допустить повторения этой сцены.
Это руководство по документированию вашего первого проекта. Первый раз всегда самый трудный, и я надеюсь, что это руководство поможет вам начать праведный путь.В конце, у вас должен быть проект, готовый к публичному выпуску.
Не стесняйтесь читать этот документ полностью, или просто использовать его в качестве ссылки.
Зачем писать документы
Вы будете использовать свой код через 6 месяцев
Код, который вы написали 6 месяцев назад, часто неотличим от кода, написанного кем-то другим. Вы будете смотреть на файл с теплым чувством воспоминаний. Затем подкрадывающееся чувство предчувствия, зная, что это написал кто-то менее опытный, менее мудрый.
Когда вы проходите этот самоотверженный акт распутывания вещей, которые были очевидны или умны несколько месяцев назад, вы начнете сопереживать своим пользователям. Если бы я только написал, почему я это сделал. Жизнь была бы намного проще. Документация позволяет перевести почему за кодом. Точно так же комментарии к коду объясняют , почему , а не как , документация служит той же цели.
Вы хотите, чтобы люди использовали ваш код
Вы написали кусок кода, и выпустил его в мир.Вы сделали это, потому что думаете, что это может быть полезно другим. Тем не мение, люди должны понимать, почему ваш код может быть им полезен, прежде чем они решат его использовать. Документация говорит людям, что этот проект для них.
Если люди не знают, зачем существует ваш проект,
они не будут его использовать.
Если люди не могут понять, как установить ваш код,
они не будут его использовать.
Если люди не могут понять, как использовать ваш код,
они не будут его использовать.
Есть небольшое количество людей, которые будут использовать исходный код и использовать его. Это исчезающе малое количество людей, по сравнению с людьми, которые будут использовать ваш код, если он правильно задокументирован. Если вы действительно любите свой проект, задокументировать это, и пусть другие люди используют его.
Вы хотите, чтобы люди помогали
Открытый исходный код, это волшебная вещь, верно? Вы выпускаете код, и кодовые гномы приходят и делают его лучше для вас.
Не совсем.
Открытый исходный код может быть удивительным во многих отношениях. но он не существует вне законов физики.Вы должны положить работу в, чтобы получить работу.
ДокументацияВы получаете взносы только после того, как проделаете большую работу.
Вы получаете взносы только после того, как у вас появятся пользователи.
Вы получаете взносы только после того, как у вас есть документация.
также предоставляет платформу для ваших первых вкладов. Многие люди никогда раньше не вносили свой вклад, и изменения в документации гораздо менее страшны, чем изменения в коде. Если у вас нет документации, вы упустите целый класс участников.
Вы хотите, чтобы ваш код был лучше
Очень легко иметь в голове идею, которая звучит идеально, но акт воплощения слов на бумаге требует дистилляции мысли, что может быть не так просто.
Написание документации улучшает дизайн вашего кода. Обсуждение вашего API и дизайнерских решений на бумаге позволяет вам думать о них более формализованно. Приятным побочным эффектом является то, что это позволяет людям вносить код, который также соответствует вашим первоначальным намерениям.
Вы хотите стать лучшим писателем
Написание документации — это форма написания, отличная от той, с которой знакомо большинство людей. Техническое письмо — это искусство, которое не приходит само собой. Написание документации поможет вам стать лучшим техническим писателем. который является полезным навыком для программиста.
Со временем писать становится легче. Если ты не пишешь много месяцев, гораздо труднее снова начать писать. Документирование ваших проектов позволит вам писать с разумной частотой.
Начать с простого — лучший способ добиться реальных результатов. Я представлю хорошо вымощенную дорожку, по которой можно спуститься, и после того, как у вас есть основная идея, вы можете расширить свой кругозор. Инструменты должны быть мощными и простыми в использовании. Это устраняет препятствия для фактического размещения слов на странице.
Контролируемый версиями обычный текст
Мы, программисты, живем в мире простого текста. Наш инструментарий для документации не должен быть исключением. Нам нужны инструменты, которые превращают обычный текст в красивый HTML.У нас также есть одни из лучших инструментов для отслеживания изменений в файлах. Почему мы должны отказаться от использования этих инструментов при написании документации? Этот рабочий процесс является мощным и знакомым разработчикам.
Основной пример
Ресурсы --------- * Электронная документация: http://docs.writethedocs.org/ * Конференция: http://conf.writethedocs.org/
Это будет отображено в заголовке, со списком под ним. URL-адреса будут автоматически связаны гиперссылками. Легко писать, по-прежнему имеет смысл как обычный текст, и прекрасно отображается в HTML.
README
Ваши первые шаги в документации должны войти в ваш README. Службы хостинга кода автоматически преобразуют ваш README в HTML, если вы укажете правильное расширение. Это также первое взаимодействие большинства пользователей с вашим проектом. Так что наличие прочного README хорошо послужит вашему проекту.
Некоторые люди даже начинают свой проект с README
Что написать
Теперь приступим к делу.Убедитесь, что вы предоставляете своим пользователям всю необходимую им информацию, но не слишком много.
Во-первых, вам нужно спросить себя, для кого вы пишете. Во-первых, вам вообще достаточно обратиться к двум аудиториям:
Пользователи — это люди, которые просто хотят использовать ваш код, и плевать как он работает. Разработчики — это люди, которые хотят внести свой вклад в ваш код.
Какую проблему решает ваш проект
Многие люди будут обращаться к вашей документации, пытаясь понять, что именно представляет собой ваш проект.Кто-то упомянет об этом или случайно наберет фразу в гугле. Вы должны объяснить, что делает ваш проект и почему он существует. Ткань отлично справляется с этой задачей.
Небольшой пример кода
Покажите наглядный пример того, для чего обычно используется ваш проект. Запросы являются отличным примером этого.
Ссылка на ваш код и систему отслеживания ошибок
Людям нравится иногда просматривать код. Они могут быть заинтересованы в регистрации ошибок в коде для проблем, которые они обнаружили.Сделайте это действительно простым для людей, которые хотят внести свой вклад в проект любым возможным способом. Я думаю, что Руководство по Python хорошо справляется со ссылкой на часть кода.
Часто задаваемые вопросы (FAQ)
У многих людей одни и те же проблемы. Если что-то происходит постоянно, вам, вероятно, следует исправить свою документацию или код, чтобы проблемы исчезли. Тем не менее, всегда есть вопросы, которые задают о вашем проекте, вещи, которые нельзя изменить, и т. д. Задокументируйте их, и держите их в курсе .Часто задаваемые вопросы, как правило, устарели, но когда они сделаны правильно, они являются золотым ресурсом. Tastypie отлично справились с этой задачей благодаря своей концепции «Поваренной книги».
Как получить поддержку
Список рассылки? IRC-канал? Задокументируйте, как получить помощь и взаимодействовать с сообществом вокруг проекта. Django отлично с этим справляется.
Информация для тех, кто хочет внести свой вклад
У людей обычно есть стандарты того, как они ожидают, что что-то будет сделано в их проектах.Вы должны задокументировать их, чтобы, если люди пишут код, они могли делать что-то в соответствии со стандартами проекта. Open Comparison прекрасно справляется с этой задачей.
Инструкции по установке
Как только люди поймут, хотят они использовать ваш код или нет, им нужно знать, как получить его и заставить работать. Надеюсь, ваши инструкции по установке должны состоять из пары строк для основного случая. Страница, которая дает дополнительную информацию и предостережения, должна быть связана отсюда, если это необходимо. Я думаю, что в Read the Docs мы хорошо с этим справились.
Лицензия вашего проекта
БСД? Массачусетский технологический институт? GPL? Эти вещи могут не иметь значения для вас, но люди, которые хотят использовать ваш код, будут очень заботиться об этом. Подумайте, чего вы хотите добиться с помощью своей лицензии, и, пожалуйста, выберите только одну из стандартных лицензий, которые вы видите в Интернете.
Шаблон
Простой шаблон для начала,
для вашего README
.
Назовите файл README.md
, если вы хотите использовать уценку,
или README.rst
, если вы хотите использовать reStructuredText.
Более подробную информацию об этом можно найти на боковой панели разметки.
$проект ======== $project решит вашу проблему, с чего начать с документацией, путем предоставления основных объяснений того, как это сделать легко. Посмотрите, как легко им пользоваться: импортировать проект # Займись своими делами проект.do_stuff() Функции -------- - Будь офигенным - Сделать вещи быстрее Установка ------------ Установите $project, запустив: установить проект Способствовать ---------- - Трекер проблем: github.com/$проект/$проект/вопросы - Исходный код: github.com/$project/$project Служба поддержки ------- Если у вас возникли проблемы, сообщите нам об этом. У нас есть список рассылки, расположенный по адресу: [email protected] Лицензия ------- Проект распространяется под лицензией BSD.
Техническое письмо | Научные документы
РУКОВОДСТВО ПО ТЕХНИЧЕСКОМУ НАПИСАНИЮ
В хорошем техническом письме используется точный и основанный на фактах язык. Следующие рекомендации помогут вашим читателям понять, что вы пишете.
ИСПОЛЬЗУЙТЕ ЖАРгон ДОЛЖНЫМ ОБРАЗОМ
Жаргон относится к использованию слов, которые являются специализированными или подходящими для определенной группы. Жаргон является отличительной чертой технического письма, и его использование желательно, поскольку оно облегчает общение между членами группы.
Однако авторы должны быть уверены, что читатели знакомы со всеми специальными терминами, используемыми в документе. Документы, содержащие «жаргон», могут показаться читателям непонятными или претенциозными. Если вы пишете для широкой аудитории, дайте определение новым терминам или, если возможно, замените более общими терминами.
ИСПОЛЬЗУЙТЕ ГЕНДЕРНО-НЕЙТРАЛЬНЫЙ ЯЗЫК
Времена, когда писатели использовали «он» для обозначения людей, занимающихся «мужскими» занятиями, а «она» — для «женских», давно прошли. Когда вы ссылаетесь на должность человека, не делайте суждений о его половой принадлежности, используйте нейтральные термины. Вашим воспитателем вполне может быть женщина, а вашей медсестрой — мужчина. Примеры гендерно нейтрального языка включают:
— Пожарный вместо пожарного
— Продавец или торговый представитель вместо продавщицы, продавщицы или продавца
— Бортпроводник вместо стюардессы или стюарда
— Офицер полиции вместо полицейского или женщины-полицейского
— Пресс-секретарь вместо пресс-секретаря
— Синтетические или искусственные вместо искусственных
— Рабочий вместо рабочего
ИСПОЛЬЗУЙТЕ ПРОСТЫЕ ПРЕДЛОЖЕНИЯ
Чем сложнее предложение, тем труднее его понять, особенно читателям, незнакомым с темой.Некоторые начинающие писатели, особенно те, кто обучен академическому письму, пытаются произвести впечатление на читателей длинными и сложными предложениями. Если вы обнаружите, что попали в эту ловушку, перепроверьте свои предложения, чтобы увидеть, есть ли более прямой способ написать то же самое. Представьте, как кто-то на самом деле сказал бы это предложение в разговоре. Например, хотя в типичном отчете может быть указано: «Его начальнику было известно, что оборудование неисправно», мало кто скажет, что это так. Большинство просто сказали бы: «Его начальник знал, что оборудование неисправно».Написание предложения таким образом обеспечивает более четкое и прямое сообщение для читателей.
ИЗБЕГАЙТЕ ПАССИВНЫХ И НЕОБХОДИМЫХ СЛОВ
Точно так же используйте простые, понятные слова и выражения. Например:
— Использовать вместо использования
— Начать вместо инициировать
— Лицо вместо физического лица
— Теперь вместо
на данный момент— Потому что вместо того, что
— рассмотреть вместо рассмотрения
— Расследование вместо проведения расследования
— Подать заявку вместо подачи заявки
Избегайте ненужного повторения слов (избыточности).Например: конечные результаты или окончательные результаты, выделенные красным цветом, чтобы вернуться назад, все, объединиться.
ИСПОЛЬЗУЙТЕ АКТИВНЫЙ ГОЛОС
Активный голос — один из краеугольных камней четкого письма. В технической письменной форме он почти всегда предпочтительнее пассивного залога. Использование активного залога придает вашему письму авторитет и воодушевление. Он обращается непосредственно к читателям, не оставляя им сомнений в том, кто или что осуществило действие.
Активный или пассивный голос?
Голос в письменной форме относится к тому, действует ли субъект предложения или получает действие.
В активном залоге субъект выполняет действие; например: «Менеджер рекомендовал провести расследование».
В пассивном залоге субъект получает действие; например: «Расследование было рекомендовано менеджером».
Для сравнения, пассивному залогу не хватает ясности и акцента, хотя могут быть случаи, когда вы будете его использовать, особенно в случаях, когда тема неизвестна или менее важна, чем действие. Например, «Соединительный шнур изготовлен из гибкого термостойкого материала».
ИСПОЛЬЗОВАНИЕ ОБЯЗАТЕЛЬСТВ
Императивы — это инструкции или директивы. Они сообщают читателю, что или как делать. Например, «Прочитайте следующие инструкции».
Разница между императивом и действительным залогом в том, что действительный залог делает утверждение, но не дает указаний читателю. Например, «Инструкции описывают, как собрать машину».
Используйте императивы при написании инструкций, процедур и руководств по эксплуатации.В этих документах читатель нуждается в четких, недвусмысленных указаниях и будет благодарен за ваше руководство.
ВЫБОР ПЕРВОГО, ВТОРОГО ИЛИ ТРЕТЬЕГО ЛИЦА
Решение о том, писать ли от первого, второго или третьего лица, зависит от того, насколько формальным вы хотите, чтобы документ был.
Первое лицо – я, я, мы
Второй человек – Вы
Третье лицо – Он, она, они, они
Написание от первого лица с использованием «я» или «мы» означает, что автор играет центральную роль в документе, поэтому написание не может быть объективным.Письмо от первого лица используется в отчетах, служебных записках, деловых письмах и некоторых типах академического письма, когда автор хочет заявить о своих полномочиях или мнениях.
Написание от второго лица означает, что вы обращаетесь непосредственно к читателю. Это придает документу непринужденный, дружелюбный тон, который помогает читателю сосредоточиться на содержании. Он подходит для написания инструкций, заметок и практических руководств. Однако этот стиль не подходит для других, более формальных типов технического письма.
Академические письма, научные отчеты, деловые отчеты и некоторые типы справочников обычно требуют более отстраненного, размеренного тона. Вам не нужно (или не хочется) создавать личную связь с читателем в таких типах письма; конечно, читатель не захочет быть слишком осведомленным о вашем присутствии. Писать от второго или от первого лица, скорее всего, прозвучало бы самонадеянно, неуклюже и непрофессионально. Написание от третьего лица создает соответствующее ощущение дистанции или формальности между читателем и писателем.
ИСПОЛЬЗУЙТЕ ПРАВИЛЬНУЮ ПРАВОПИСАНИЕ, ГРАММАТИКУ И ПУНКТУАЦИЮ
Правильное написание необходимо во всех типах технических документов. Слова с ошибками отвлекают, непрофессионально и потенциально могут ввести в заблуждение. Используйте словарь, если вы не уверены в слове, и будьте особенно осторожны с незнакомыми техническими терминами и именами людей. Используйте таблицу стилей (см. Урок 6), чтобы обеспечить единообразие правописания во всем документе.
Грамматика — это набор правил, общепринятых в любом языке.Хороший писатель будет:
— Делайте предложения короткими и четкими.
— Меняйте длину предложений.
— Используйте правильный синтаксис (т.е. правильное расположение слов в предложении).
Есть много правил, касающихся грамматики — изучите их, и если вы все еще не уверены, соответствует ли что-то «хорошему английскому», руководствуйтесь здравым смыслом. Если предложение звучит неуклюже или неправильно, измените его!
Знаки препинания предназначены для облегчения понимания текста читателем.Плохая пунктуация затемняет смысл и разрушает ход мыслей читателя.
Все писатели должны уметь правильно расставлять знаки препинания. В качестве отправной точки убедитесь, что вы точно знаете, как использовать распространенные знаки препинания: запятые, точки, точки с запятой, двоеточия, апострофы, квадратные скобки, дефисы, вопросительные знаки и кавычки.
Технические редакторы также должны быть знакомы с менее часто используемыми знаками препинания, такими как en rules, em rules, эллипсами и солидами.
Узнайте больше: Нажмите здесь, чтобы увидеть наш курс технического письма
Вас также может заинтересовать….
3.3 Списки – Основы технического письма
Сюзан Ласт
Списки, при правильном использовании, могут быть лучшим другом технического писателя и читателя. Списки позволяют подчеркнуть важные идеи.Они также повышают удобочитаемость текста, упрощая длинные предложения или абзацы и добавляя эстетическое пассивное пространство, чтобы сделать чтение более приятным. Однако использование неправильного типа списка или плохое форматирование списка может создать путаницу, а не улучшить читабельность. Поэтому важно понимать различные типы списков и то, как и зачем их использовать.
При создании списков любого типа придерживайтесь следующих рекомендаций:
- Включить между 2-8 элементами списка.У вас должно быть как минимум два элемента в списке (или это не список, а просто элемент). Избегайте более 8 элементов в списке, так как слишком много элементов может иметь обратный эффект. Если вы подчеркнете слишком много идей, вы ничего не подчеркнете. НАСА рекомендует не более 8 шагов в чрезвычайной ситуации; больше 8 может быть ошеломляющим в кризисной ситуации.
- Старайтесь избегать разделения списка на две страницы, если это возможно.
- Избегайте чрезмерного использования списков . Вокруг списка всегда должен быть пояснительный текст, чтобы указать, что это за список и зачем он нужен.Серия списков не дает читателю адекватной информации и контекста.
- Отрегулируйте интервал до, после и внутри списков для повышения удобочитаемости. Избегайте сжимания списка информации в плотный блок текста; это противоречит цели повышения удобочитаемости.
- Сделать заглавной первую букву каждого элемента списка.
- Используйте параллельную формулировку для каждого элемента в списке (обратите внимание, что каждый элемент в этом списке начинается с глагола, выделенного жирным шрифтом только для того, чтобы привлечь ваше внимание, а не как стиль, которому вы должны следовать).
- Никогда не используйте заголовок для введения списка.
Каждый вид списка подходит для определенных целей. Все списки должны соответствовать набору правил построения и форматирования. Обучение использованию инструмента форматирования Paragraph в Word (см. Рисунок 3.3.1 ) имеет решающее значение для разработки эффективных списков.
Рисунок 3.3.1 Скриншот инструментов Paragraph в Word 2010; вы можете автоматически создавать списки, используя левые верхние кнопки.ПРИМЕЧАНИЕ : Если вы создаете списки, нажимая ENTER, затем TAB, а затем тире, вы делаете это неправильно, и это затруднит редактирование и поддержание удобочитаемости в будущем, если вообще возможно. Вы должны убедиться, что используете правильные инструменты форматирования, особенно при совместном написании документов, которые потребуют тщательной проверки и редактирования.
Точно так же, как гистограммы служат другим целям, чем круговые диаграммы, разные виды списков также служат разным целям.В этом разделе описывается, когда и как использовать следующие пять часто используемых типов списков:
- Маркированные списки : используйте, когда порядок элементов в списке не важен
- Нумерованные списки : используйте, когда порядок важен, например, шаги в инструкциях
- Списки в предложениях : используйте, когда вы хотите сохранить структуру предложений и абзацев, а также иметь краткий список (2-4 пункта)
- Маркированные списки : используйте, когда перечисленные элементы требуют некоторого объяснения или дополнения (например, этот)
- Вложенные списки : используйте, когда перечисленные элементы имеют подсписки (список в списке).
Маркированные списки являются наиболее часто используемым типом списков. Они эффективны, когда
- Вы хотите выделить два или более элемента
- Вы можете размещать предметы в любом порядке (особый порядок не требуется)
- Вы хотите добавить в документ пустое пространство, чтобы улучшить читаемость.
Элементы маркированного списка обычно должны быть короткими (слово или фраза). Если вы обнаружите, что ваши маркированные элементы длиннее этого, рассмотрите возможность использования другого типа списка, например маркированного списка или вложенного списка.
НОМЕРНЫЕ СПИСКИИспользуйте нумерованные списки, когда важен порядок элементов в списке и идеи должны быть выражены в хронологическом порядке. Например, используйте нумерованный список, когда вы должны перечислить ряд шагов в инструкциях или когда вы представляете идеи, которые будут обсуждаться в определенном порядке в следующем тексте. Если у вас есть список из более чем 8 элементов, рассмотрите возможность разбиения списка на два или более этапов или категорий (шаги на этапе 1, шаги на этапе 2, и т. д. .).
Доработка вашего документа должна проводиться в 4 этапа в следующем порядке:
- Проверить форматирование на читабельность
- Просмотрите содержимое, чтобы убедиться, что документ содержит всю необходимую информацию
- Изменить стиль и структуру предложения, чтобы идеи были четко и правильно выражены в формальной и точной манере
- Вычитка грамматических, орфографических, пунктуационных и служебных ошибок.
ПРИМЕЧАНИЕ : Каждый из 4 шагов в примере нумерованного списка начинается с глагола ( проверить , просмотреть , изменить и исправить ), указывающего, что должен сделать читатель, а числа указывают порядок, в котором эти шаги должны быть выполнены.
СПИСКИ В ПРЕДЛОЖЕНИЯХИспользуйте списки в предложениях, если вы хотите (а) сохранить стиль абзаца, (б) избежать слишком большого количества списков на одной странице и (в) когда элементы списка относительно короткие и могут быть четко выражены в предложении без создание наката. Предыдущее предложение является примером списка в предложении. Обратите внимание, что каждый элемент списка обозначается строчной буквой в квадратных скобках.
Обычно списки в предложениях состоят из 2-4 пунктов. Как правило, избегайте включения в такой список более 4 пунктов (если только они не очень короткие), иначе ваше предложение может стать трудным для чтения.
МАРКИРОВОЧНЫЕ СПИСКИИспользуйте маркированный список, когда перечисляете элементы, требующие дополнительных пояснений. Они могут быть промаркированы или пронумерованы. Начните элемент списка со слова или термина (часть «метка»), выделенного курсивом и/или жирным шрифтом, после которого следует двоеточие. После двоеточия напишите объяснение или расширение термина или понятия в обычном основном тексте.
План оценки курса включает три основных письменных задания, которые даются в следующем порядке:
- Первый отчет : внутреннее предложение, написанное в формате памятки
- Второй отчет : внутреннее предложение, написанное в формате краткого отчета
- Третий отчет : сравнительный отчет с рекомендациями, написанный для внешнего клиента в формате развернутого отчета.
План также включает две устные презентации:
- Презентация 1 : Индивидуальная или парная презентация на тему технического письма (стоимость 5%)
- Презентация 2 : Презентация команды с отчетом о ходе выполнения Отчета 3 (стоимостью 10%).
Убедитесь, что части этикетки (до двоеточия) сформулированы последовательно и выделены курсивом или полужирным шрифтом (или и тем, и другим!) для выделения; постарайтесь сделать объяснения, которые следуют, примерно одинаковыми по длине и деталям.
ВЛОЖЕННЫЕ СПИСКИ«Вложенный» список — это список в списке или список с подпунктами. Это может быть полезно, чтобы избежать слишком длинных маркированных списков, разделив элементы на подсписки. Обратите внимание, что длинный маркированный список слева не позволяет эффективно классифицировать элементы, поэтому акцент теряется. Вложенный список справа более эффективен.
Образец маркированного списка (слишком длинный) | Образец вложенного списка |
В каждом ресторане должны быть следующие контейнеры для напитков:
(12 пунктов слишком много для одного списка!) | Каждый ресторан должен иметь следующие виды контейнеров для напитков:
|
Это не исчерпывающий список типов списков, с которыми вы можете столкнуться при техническом чтении. Это просто самые распространенные типы списков, которые вы должны уметь идентифицировать и эффективно использовать в своих технических заданиях по письму, чтобы улучшить читаемость.
Условные обозначения элементов списка пунктуации зависят от контекста. В юридическом письме, как правило, используется больше знаков препинания, чем в техническом (элементы списка часто заканчиваются точкой с запятой, а последний элемент начинается с «и»).В технических документах, поскольку этот стиль способствует простоте, вы обычно ставите точку только после последнего элемента списка. Если в каждом элементе списка есть полные предложения, вы поставите точку в конце каждого элемента списка. Если у вас есть простой маркированный список, вы можете опустить последнюю точку.
Список пяти видов :
- Маркированные списки
- пронумерованных списков.
- Списки можно составлять в предложении, используя буквы в квадратных скобках для обозначения элементов списка.
- вложенный список
- Также называется «список в списке»
- Маркированный список
Так же, как существуют правила составления списков, существуют правила их включения в текст. Самое главное, список должен начинаться с вводного предложения (или предложения), которое содержит как подлежащее, так и глагол. Технические писатели часто используют выражение «следующее» где-нибудь во вступительном предложении, чтобы четко указать, что за ним последует список элементов.
Если вступление представляет собой законченное предложение, содержащее как подлежащее, так и глагол ( т. е. . оно может заканчиваться точкой), оно должно заканчиваться двоеточием, которое вводит перечисленные элементы. Если предложение не является законченной мыслью ( т.е. . вы могли бы , а не поставить там точку), вводная часть не должна заканчиваться никаким знаком препинания, и каждый перечисленный элемент должен грамматически завершать вводную фразу. .
Полное вводное предложение ( заканчивается двоеточием )
Конкурсный проект должен позволять учащимся включать в свое решение следующие элементы:
- Принципы машиностроения
- Знания в области электротехники
- Программное обеспечение/основы программирования.
Неполное вводное предложение ( без знаков препинания после вводного )
Конкурсный проект должен позволить учащимся разработать решение с использованием
- Принципы машиностроения
- Знания в области электротехники
- Программное обеспечение/основы программирования.
СОВЕТ ПО ГРАММАТИКЕ: Одна из наиболее распространенных ошибок в технических отчетах связана с введением списков и их пунктуацией.Вот несколько дополнительных примеров того, как — и как НЕТ — вводить списки.
Не используйте двоеточие перед списком , если только введение в список не является законченной мыслью, то есть независимым пунктом . Помните правило: если нельзя поставить точку, то нельзя поставить двоеточие.
В некоторых случаях список может оказаться бесполезным, а может лишь чрезмерно усложнить документ. В таких случаях перечислите свои идеи в форме предложения внутри абзаца, как в последнем примере с пандой ниже.Страница со слишком большим количеством списков выглядит как набросок, а не последовательно выраженный ряд идей.
Панды обладают следующими чертами:☑
Общие характеристики панд включают: ×
| Панды: ×
Панды ☑
Панды имеют черно-белый мех, питаются вегетарианской пищей и могут решать сложные задачи. ☑ |
- Наше решение направлено на достижение следующих целей
- Конструктивные ограничения, которые необходимо учитывать:
- Все предлагаемые конструкции должны соответствовать следующим ограничениям
- Предлагаемые решения предлагают множество ощутимых преимуществ, таких как
- Предлагаемое решение предлагает следующие ощутимые преимущества
1.Тип списка: | 2. Тип списка: |
Пересмотр вашего документа должен проходить в 4 этапа:
| План оценивания для этого курса включает три основных письменных задания:
|
3. Тип списка: | 4.Тип списка: |
7 Cs относятся к семи характеристикам эффективного профессионального письма. Это письмо должно быть
| Термин «дизайн-проект» проверяет ваше знание следующих принципов:
|
- Создайте свой собственный список с помощью инструментов для работы с абзацами в Word.Например, составьте список как можно большего количества видов транспортных средств, проявляя творческий подход. Если вы можете придумать более 8, подумайте, какой список будет наиболее подходящим.
- Не могли бы вы разделить их на вложенные списки? Какие категории?
- Подумайте, какой текст будет вводным и последующим за вашим списком.
- Какой документ будет содержать список типов транспортных средств? Кто бы это читал?
- Прочтите статью Фаркаса «Понимание и использование PowerPoint» (.pdf) и создайте набор маркированных заметок, обобщающих его идеи о «Критериях создания маркированных пунктов».
Просмотрите списки PowerPoint для этой главы.
.
0 thoughts on “Правила написания документов: 3 Общие требования к созданию документов / КонсультантПлюс”