Правила написания документов: 3 Общие требования к созданию документов \ КонсультантПлюс

Требования к оформлению документов по делопроизводству

Содержание страницы

1. Правила оформления документов и их значение
2. Требования ГОСТа
3. Документы организации: учитываем новый стандарт

Независимо от формы собственности организации, вида ее деятельности, наименования документации, места ее составления существуют общие требования по оформлению документов. Ранее делопроизводители ориентировались на стандарт 6.30-2003 при оформлении документов, но относительно недавно в действие был введен новый ГОСТ. Какие требования имеют место при ведении делопроизводства и насколько серьезные изменения внес в эту сферу действующий менее года государственный стандарт, рассказывается в статье.

Как организовать делопроизводство и документооборот в организации?

Правила оформления документов и их значение

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

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

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

Требования, в соответствии с которыми оформляется документ, устанавливаются на федеральном уровне ГОСТом. Это документ нормативно-технического характера, на основе которого каждая организация, ведомство, учреждение разрабатывает свои нормативные акты, касающиеся оформления документации:

• положения о документообороте;
• инструкции;
• правила;
• регламенты.

Национальный стандарт России о требованиях к оформлению документов.

Требования к оформлению документов по ГОСТу включают в себя в том числе порядка 30 реквизитов, предназначенных для различных целей. Каждый вид документа содержит собственный набор необходимых реквизитов.

Соблюдение требований к созданию и оформлению документации необходимо:

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

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

Требования ГОСТа

ГОСТ Р 7.0.97-2016 введен в действие 01/07/18, и именно он устанавливает базовые требования по оформлению документов в делопроизводстве. Рассмотрим обзорно, что собой представляет этот документ.

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

1. Общие требования к созданию документа. Сюда входят: характеристика материальных носителей документа (бумажный, электронный), порядок нумерации страниц, рекомендуемые для набора шрифты, отступы, интервалы, выравнивание, длина строки – в цифрах, с выделением важных нюансов.
2. Состав реквизитов. Первая группа 01-08 включает в себя герб, товарный знак, знак обслуживания, код документальной формы, наименование организации, ее подразделения, должности автора документа, данные организации справочного характера. Вторая группа 09-16 объединяет данные о документе: наименование, дату, номер, ссылку на рег. номер, где составлен, пометку об ограничении доступа, кому адресован, гриф, подтверждающий утверждение. Третья группа 17-18 – это реквизиты заголовка текста и сам текст.  Четвертая группа 19-30 – различные визирующие, резолюционные, контрольные, согласовательные отметки, подпись, печать, данные об исполнителе. По каждому реквизиту даны рекомендации, как он оформляется и где располагается в документе. К примеру, подчеркивается, что наименование вида документа можно опустить, только если это деловое письмо, а место составления можно не указывать, если указание на местонахождение организации уже есть в ее наименовании.
3. Бланки. Отдельно законодатель характеризует бланки документов, рекомендуемый формат для обычных документов, для резолюций, предельные размеры полей. Следует описание, как должны располагаться реквизиты на том или ином бланке, какого вида бумага должна использоваться.

В приложениях А, В даны:

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

На заметку! В ГОСТе уделено много внимания вопросам электронного документооборота, в связи с его все более широким распространением.

Документы организации: учитываем новый стандарт

На какие реквизиты документов и правила оформления следует обратить внимание особое внимание, используя ГОСТ Р 7.0.97-2016, прежде всего?

Вот эти важные моменты:

1. Шрифты. Для создания документа размер шрифтов ограничен, можно использовать только 12, 13, 14 номера. Допускается более мелкий шрифт, но только в таблицах.
2. Герб. На документах теперь можно отражать герб субъекта РФ, муниципального образования (10 мм от верха листа).
3. Реквизиты. Такие реквизиты фирмы, как ОКПО, ОГРН, ИНН, КПП, указываются в составе реквизита «справочные данные об организации».
4. Отметка об ограничении доступа к информации документа. Она проставляется на первом листе, сверху, в углу.
5. Обращение к адресату. Теперь можно использовать обращение «господин» и «госпожа», сокращая его: «г-ну», «г-же». Если у адресата есть электронная почта и письмо отправлено по этому каналу, можно указать электронный адрес, на который отправлялось письмо.
6. Печать организации. Она не должна «перекрывать» подпись должностного лица под документом.
7. Подпись. Гражданин, имеющий право подписывать документы за временно отсутствующего руководителя, не может в напечатанном бланке перед должностью руководителя ставить знак косой черты, использовать предлог «за». Исправление может быть внесено от руки или поставлен определенного вида штамп, свидетельствующий о том, что подписывает документ другой человек.

Заключение

Требования к оформлению документов в делопроизводстве устанавливаются в настоящее время государственным стандартом, действующим с середины прошлого года за №Р 7.0.97-2016. На основе ГОСТа организации и учреждения разрабатывают собственные нормативы по оформлению документации. Стандартизация документооборота необходима, поскольку дает возможность оперативно обрабатывать, искать и копировать документы. Исполнение требований по оформлению документов позволяет говорить о них как о юридически значимых.

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

ГОСТ по делопроизводству и документообороту 2023. Оформление документации по ГОСТ р 7.0.97-2016

Гончарова Алина Юрист

13 мая 2021

162288

Распечатать

Поделиться

Размер шрифта:

ГОСТ по оформлению документов в 2023 году — это свод правил, на основании которых составляют организационно-распорядительные бумаги.  

Содержание

Порядок оформления деловой документации утвержден отдельным Госстандартом России: статус ГОСТа р 7.0.97-2016 на 2023 год не изменился, он продолжает действовать и в этом отчетном периоде. К базовому нормативу Федеральное архивное агентство разработало Методические рекомендации по его применению. Обратите внимание, что 24.12.2020 Росархив утвердил новые методические рекомендации по разработке инструкций по делопроизводству в госорганах и органах местного самоуправления.

Об обновленном стандарте документооборота

Изначально планировалось ввести стандарт в действие 08.12.2016. Но Приказ Росстандарта № 435-ст от 25.05.2017 отсрочил внедрение на полтора года. С 01.07.2018 вступил в силу новый ГОСТ по делопроизводству и документообороту: в 2023 году стандарт распространяется на всю организационно-распорядительную документацию как в бумажной, так и в электронной форме, хотя и является добровольным к исполнению.

Госстандарт Р 7.0.97-2016 ссылается на два документа: ГОСТ «Делопроизводство и архивное дело» Р 7. 0.8 от 17.10.2013 и «Управление документами» Р ИСО 15489-1-2019. Кроме обновленных правил работы с документацией, новые требования к делопроизводству с 2021 г. включают приложения с формами бланков и схемами расположения реквизитов.

С 2020 года действуют новые сроки хранения организационной документации. Они утверждены приказом Росархива № 236 от 20.12.2019. В нормативе приводится перечень типовых документов по направлениям деятельности в организации и период их хранения. Данная информация будет крайне актуальна при формировании новой номенклатуры.

Эксперты КонсультантПлюс разобрали, как организовать делопроизводство и документооборот в организации. Используйте эти инструкции бесплатно.

Для чтения получите доступ в КонсультантПлюс (бесплатно на 2 дня)

Основные новшества

Новый стандарт устанавливает ряд новых правил, отличающихся от тех, что были приведены в старом. К наиболее важным относятся:

1. Порядок создания и правила оформления документов в делопроизводстве 2023 г. Здесь рассматривают такие вопросы, как шрифты и гарнитуры, абзацные отступы и интервалы, поля и форматирование.
2. Инструкция по заверению копий документов. Обязательная надпись расширилась.
3. Система оформления реквизитов. Изменились привычные, появились новые и исключены некоторые старые.

Стандарт отличается нумерацией реквизитов. Рассмотрим все нововведения более детально.

Порядок оформления документов

Почти весь документооборот ведется на компьютере, но допускается и бумажная документация (п. 3.1 ГОСТ). Было решено, что правила их стилевого оформления необходимо зарегламентировать. Теперь допустимо печатать документ с двух сторон листа. Сейчас поля в документе по ГОСТу в 2023 г. оформляют по новым правилам: следует проставить одинаковые размеры для левого поля лицевой страницы и правого оборотной (п. 3.2 Госстандарта). Кроме того, при создании документации на двух и более страницах, второй и следующие листы необходимо пронумеровать. Номера страниц проставляют в середине верхнего поля на расстоянии не менее 10 мм от верхнего края листа.

По новому регламенту отдается предпочтение свободно распространяемым бесплатным шрифтам размера 12, 13, 14. Ранее в Госстандарте в п. 3.3 были указаны конкретные шрифты: Times New Roman, Calibri, Arial, Verdana, но в новой редакции наименования шрифтов убраны.

Другие правила оформления делового письма по ГОСТу в 2023 году:

1. Для экономии места уменьшают шрифты в таблицах.
2. Интервал используют как полуторный, так и одинарный. Рекомендованный абзацный отступ — 1,25 см (Приказ 244-ст от 14.05.2018).
3. Регламент устанавливает требование к длине строки. При книжной ориентации она не превышает 7,5 см, при альбомной — 12 см (п. 3.5 Госстандарта).

Например, оформление приказа по ГОСТу в 2023 г. выглядит так:

Как проставлять отметки

Изменились правила заверения копий. Первая часть заверяющей надписи осталась прежней. Она состоит из слова «Верно», ФИО, должности и подписи лица, уполномоченного на ее проставление, и даты.

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

Еще одно важное новшество, включенное в правила оформления приказов в делопроизводстве по ГОСТу в 2023 г., — отметка об электронной подписи. Во времена принятия предыдущего стандарта ее еще не использовали. А теперь стоит запомнить состав такой отметки:

• надпись «Документ подписан электронной подписью»;
• номер сертификата ключа;
• ФИО его владельца;
• срок его действия.

Возможно присутствие герба Российской Федерации, эмблемы органа власти или эмблемы организации.

Какие реквизиты поменялись

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

Примечательное обновление: при оформлении графы «Адресат» инициалы теперь должны стоять строго после фамилии. То же самое применимо к отметке об утверждении. Но в подписи их по-прежнему размещают перед фамилией.

Управление делопроизводством на предприятии

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

---

Вам в помощь образцы, бланки для скачивания

Скачать образец положения о документообороте в организации

Скачать образец оформления приказа по ГОСТу в 2023 году

Скачать образец оформления заявления по ГОСТу в 2023 году

Скачать образец инструкции по кадровому делопроизводству в 2023 году по новому ГОСТу

‘;}

Распечатать

Поделиться

Гончарова Алина Юрист

Юрист сайта «Правовед.ру», автор научных статей по юриспруденции.

Все статьи автора

Вам может быть интересно:

Подписывайтесь на наш канал в Telegram

Мы расскажем о последних новостях и публикациях

Подписаться

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

30 ноября 2009 г.

Введение

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

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

Итак, вот 7 правил:

1. Сухое сосание
   
2. Прежде чем начать, четко определите, что вы хотите, чтобы ваш читатель сделал после того, как вы закончите
   
3. Write to a well formed outline, always
   
4. Avoid ambiguous pronouns
   
5. clarity = illustrations + words
   
6. When dealing with concepts… logical illustration and example
   
7. Embrace revision

1. Dry отстой

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

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

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

Опять же, я всегда стараюсь сделать процесс чтения увлекательным. Я всегда осознаю, что пишу в конкурентной среде. Там много контента, который требует внимания читателя. Таким образом, мой совет для Правила № 1: если вы сделаете свое письмо забавным для себя, оно будет забавным и для читателя.

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

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

Таким образом, вам будет полезно очень четко представлять себе, что вы хотите, чтобы ваш читатель сделал после завершения чтения. Сформулируйте свое намерение в начале. Не заставляйте читателя гадать. Ваше заявление может быть простым и очевидным, например: «После прочтения этой статьи вы сможете [заполните пустое место] ». Если вы четко представляете, что вы хотите, чтобы ваш читатель сделал после того, как вы закончите, тем легче вам будет написать свою статью в начале.

3. Пишите в хорошо сформированный план, всегда

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

Написание плана — это не создание дополнительной работы. Речь идет о меньшем количестве работы. Когда вы пишете план, вы знаете, откуда вы пришли и куда идете.

Я всегда использую два правила наброска.

1. Для темы подуровня требуется по крайней мере один партнер.
   
2. Любой уровень структуры требует не менее двух предложений.

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

Листинг 1: Плохо сформированный контур0006

1.1. Шаги, необходимые для Fizzle

1.1.1. Подготовка ингредиентов

1.1.2. Смешивание шипучки

1.1.3. Обслуживание Fizzle

Обратите внимание, что в листинге 1 уровень 1 имеет один подуровень, 1.1 – шаги, необходимые для Fizzle . Эта структура является нарушением первого правила. Чтобы подуровень был правильно сформирован, для темы должен существовать хотя бы один другой одноранговый узел. Другими словами, это означает, что для любого заданного уровня должно быть как минимум два подуровня.

Посмотрите листинг 2 ниже. Обратите внимание, что теперь к уровню 1 добавлено три подуровня, из которых тема «Смешивание хлопот» теперь имеет аналоги. Единственный уровень, . Шаги, необходимые для Fizzle , были удалены.

Вы можете спросить: «Где тема, Шаги, необходимые для провала ?» Ответ заключается в том, что тема больше не является элементом структуры, а является содержимым родительской темы, как показано в листинге 2 ниже.

Листинг 2: Хорошо построенный план, который нарушает правило двух предложений

1. Приготовление шипучки с апельсином, клюквой и мандарином

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

1.1. Подготовка ингредиентов

1.2. Смешивание шипучки

1.3. Раздача fizzle

Обратите внимание, что, хотя в листинге 2 представлен план с правильно структурированным подуровнем, содержание темы уровня 1 состоит только из одного предложения. Наличие одного предложения только в качестве содержания темы плана нарушает второе правило составления плана, Для любого уровня структуры требуется как минимум два предложения .

В приведенном ниже листинге 3 показана часть Orange Cranberry Tangerine Fizzle, скорректированная в соответствии с правилом Two Sentence.

Листинг 3: Хорошо составленный план, соответствующий правилу двух предложений

1. Приготовление апельсиново-клюквенно-мандаринового шипучего

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

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

1.1. Подготовка ингредиентов

1.2. Смешивание шипучки

1.3. Подача

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

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

4. Избегайте неоднозначных местоимений

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

Рассмотрим абзац в листинге 4.

Листинг 4: Абзац с неоднозначными местоимениями

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

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

В случае с абзацем выше я не удивлюсь, если вы спросите: «Что такое Трафальгабор? Что такое Вибитата? О чем идет речь в абзаце? Как пользоваться трафальгаборами? Как использовать Weebietatas? Как использовать их обоих? Это смущает. Я возвращаюсь на свою страницу в Facebook».

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

В приведенном выше листинге 4 путаница вызвана двусмысленным использованием местоимения они во втором предложении. Относятся ли они к Трафальгаборам, Вибитатам или к обоим? Помните, пожалуйста, что читатель ничего не знает о Trafalgabors или Weebietatas. (См. рис. 1 ниже.)

Решение проблемы простое. Пожалуйста, взгляните на листинг 5 ниже. Многозначное местоимение удалено. Ясность восстанавливается.

Листинг 5: Исправление неоднозначных местоимений

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

Осторожно! Неоднозначное использование местоимений — это знак на пути к запутанному техническому письму.

5. ясность = иллюстрации + слова

Пожалуйста, взгляните на фото ниже. Скажите, если можно, о чем рисунок?

Я не удивлюсь, если вы немного озадачитесь. Это озадачивающая фотография. Вы знаете, что это за предметы, но понятия не имеете, что они означают. Такова природа иллюстрации. Картинка без слов лишена контекста.

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

Пожалуйста, взгляните на рисунок 2 ниже. Это же фото. Возникает небольшой вопрос, о чем фотография.

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

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

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

Примечание: Глаза привлекают картинки

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

6. Когда имеешь дело с понятиями… логическая иллюстрация и пример, логическая иллюстрация и пример

Понятия трудны для понимания… поэтому они называются понятиями. Итак, когда мне приходит время написать о концепции, будь то второй закон термодинамики, часть техники кодирования или полноценная программная среда, я использую в своем письме следующий шаблон: концепция — логическая иллюстрация — пример. Я стараюсь никогда не вводить понятие, не подкрепив его логической иллюстрацией, а затем примером.

Применим это правило для описания элементарного алгебраического понятия.

Переходное свойство равенства выглядит следующим образом:

Если A = B и B = C, то A = C

Теперь давайте представим логическую иллюстрацию, описывающую это понятие. (См. рис. 3.)

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

Листинг 6: Некоторые конкретные примеры транзитивного свойства равенства

• Если 7 = 3 + 4 и 3 + 4 = 5 + 2, то 7 = 5 + 2
  
• Если 12 + 5 = 7 + 10 и 7 + 10 = 6 + 11, то 12 + 5 = 6 + 11
  
• Если x + y = z и z = 2a, то x + y = 2a

Таким образом, правило as выполнено. Мы представили концепцию «Переходное свойство равенства», предоставили описательную иллюстрацию и привели конкретные примеры, подтверждающие концепцию.

Давайте перейдем к концепции, которая более актуальна для разработки программного обеспечения и немного сложнее для понимания. Концепция Maven POM Inheritance. В Приложении 1 ниже вам представлена ​​рассматриваемая концепция, а затем логическая иллюстрация, описывающая концепцию. Наконец, вам представлена ​​еще одна иллюстрация, показывающая конкретное использование файлов POM в ситуации наследования.

Приложение 1. Выдержка из технического документа, описывающего наследование Maven POM

Понимание наследования файлов POM

Файл POM (объектная модель проекта) — это XML-файл, который вы используете для описания проекта Maven и работы с ним. Вы можете настроить проект Maven для наследования настроек из отдельного родительского файла POM. Возможность наследовать настройки из родительского файла POM называется наследованием POM. Вы используете элемент в вашем файле POM, чтобы определить родительский файл POM, от которого нужно наследовать настройки.

На рисунке 4 ниже показана воображаемая иерархия проекта, которая представляет собой пример того, как вы можете настроить основной файл POM, из которого другие файлы POM могут наследовать общие настройки.

На рис. 5 ниже показано содержимое файлов POM.xml для проектов Maven, stooges-web, stooges-api и stooges-dal. Каждый проект настроен на использование элемента для наследования настроек от stooges-project.

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

Когда нужно сделать концепцию кристально ясной, проиллюстрируйте ее, а затем приведите пример.

7. Примите исправление

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

Перефразируя цитату Томаса Эдисона, «Техническое письмо состоит на 10 % из состава и на 90 % из правки!»

Бонусный раздел

Теперь, когда вы узнали о 7 правилах создания технической документации мирового класса, я собираюсь поделиться с вами процессом, который я использую для создания технической документации. Это коротко, но по делу. Я называю этот процесс «7 шагов создания технического документа» . Вот:

1. Создаю контур, как минимум до второго уровня, надеюсь до третьего.
   
2. Я добавляю в схему свою иллюстрацию для каждой концепции.
   
3. Я подписываю свои иллюстрации.
   
4. Я заполняю копию до плана, следуя Правилу двух предложений, корректируя свой план, чтобы адаптировать его к имеющейся копии.
   
5. Пересматриваю.
   
6. Я отправляю статью эксперту в предметной области на рассмотрение. (Эксперт в предметной области — это человек, который может выявить неточности и неясности в написании. )
   
7. Я снова исправляю на основе ответа рецензента(ов).

Вот оно. 7 правил, 7 шагов. Кто мог просить больше? Итак, теперь, когда вы узнали все мои приемы, не стесняйтесь идти вперед и сделать мир более точным, привлекательным, иллюстративным и интересным местом для жизни. Это стоит усилий.

Последние сообщения

Похожие статьи

Написание деловых документов: Правила написания

Для деловых документов

Ключевые критерии успеха в написании деловых документов включают:

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

См. ниже советы по достижению вышеуказанных критериев.

Легко читаемый

Удобочитаемость вашего документа улучшится, если вы:

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

Структура документа

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

Пример разделы отчета включают:

• Крышка страница
• Содержание страница
• Условия референс
• Введение
• Находки (Информация, которую вы исследовали)
• Анализ и Комментарий (Ваш анализ информации, которую вы исследовали.
• Заключение
• Каталожные номера

Как подарить информация

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

Когда вы добавляете графические элементы, все они должны быть помечены, например. Рисунок 1, Таблица 1 и т. д. Тогда вам будет проще ссылаться на эти графические элементы в тексте, добавив, например, «см. Рисунок 1 на странице 4».

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

• Плохое объяснение
• Плохая грамматика или правописание
• Запутанные термины

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

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

Достоверность информации

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

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

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

Избегайте плагиата

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

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

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

Также рекомендуется стать владельцем каждой страницы, добавив свое имя в качестве автора в нижний колонтитул каждой страницы.

Представление документа

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

• Отсутствуют орфографические, пунктуационные и грамматические ошибки
• Стиль шрифта легко читается, размер шрифта установлен от 10 до 12 пунктов
• Название отчета добавлено в заголовок
• Номера страниц добавляются в нижний колонтитул
• Ваш документ имеет правильно отформатированную титульную страницу (но убедитесь, что вы никогда не используете клип-арт!)
• Используйте цвет экономно, особенно если отчет должен быть скопирован в черном цвете.

  No related posts.