СТО УП «Стандартизация. Порядок изложения и оформления стандартов бренда develop-man»
Разработан: Орлов В.М.
1. Общие положения
1.1. Настоящий cтандарт организации является основополагающим для системы менеджмента качества и системы стандартов бренда develop-man.
1.2. Настоящий стандарт устанавливает требования к оформлению стандартов, созданных для системы стандартов бренда develop-man (далее – Система стандартов).
1.3. Требования данного стандарта обязательны для исполнения всем Разработчикам стандартов.
1.4. Целью данного стандарта является утверждение единообразного оформления и изложения стандартов организации (далее – СТО).
2. Общие требования к изложению стандартов
2.1. Разрабатываемый стандарт организации (далее – Стандарт) должен основываться на передовом отечественном и зарубежном опыте и учитывать международные и национальные стандарты.
2.2. Стандарт должен содержать в необходимом объеме обоснованные положения, направленные на достижение целей стандартизации и обеспечивающие решение конкретных задач каждого Стандарта в соответствии с областью его применения.
3. Общие требования к оформлению стандартов
3.1. В Стандарте необходимы гиперссылки на источники информации, которые были использованы при его создании в соответствии с СТО «Требование к формату передаваемой, в процессе реализации Инвестиционно Строительного Проекта, информации». Также следует использовать гиперссылки на элементы внутри Стандарта.
3.2. В случае, когда в Стандарте необходимо повторить какое-либо положение другого СТО Системы стандартов, то целесообразно сделать гиперссылку на сайт dokipedia.ru вида: СТО УП «Правила формирования корзин материалов для проведения закупок» (пункт 1.2).
3.3. Основная часть Стандарта, для каждого вида СТО, имеет свою определенную структуру, отраженную в шаблонах (см. СТО УП «Реестр шаблонов для создания стандартов организации») (кроме СТО ФД), при этом в них, в каждом разделе, приведена краткая информация о возможном его содержании.
3.4. Разработчик стандарта (далее – Разработчик) в праве формировать дополнительные разделы, необходимые для детального описания.
3.5. После названия стандарта Разработчику необходимо в поле «Разработан» внести свои Ф.И.О. в именительном падеже (кроме СТО ФД и СТО СТД) с гиперссылкой на сайт «Физические лица».
3.6. В Стандарте следует применять термины, определения которых приведены в СТО УП «Реестр терминов develop-man». Если используемый термин не определен, то в Стандарте следует создать отдельный раздел «Термины и определения», в котором дать ему определение.
3.7. Если в Стандарте используются обозначения и (или) сокращения, то при необходимости их установления создают структурный элемент: «Обозначения и сокращения».
3.8. Материал большого объема, дополняющий основные положения Стандарта, следует оформлять в виде приложений.
3.9. Текст Стандарта должен печататься на фирменном бланке бренда develop-man на базе программы MS Word с расширением «.docx».
3.10. Разрабатываемые стандарты утверждаются без ограничения срока действия. В особых случаях стандарты могут иметь ограниченный срок действия, при этом необходимо сделать отметку о сроках актуализации стандарта.
3.11. При разработке Стандарта Разработчику следует использовать элементы, иллюстрирующие суть текстовой части Стандарта.
3.12. Если в Стандарте необходимо привести какие-то формы или схемы, то они должны располагаться рационально и оформляться по общепринятым правилам и методологиям.
4. Требования к оформлению стандартов
4.1. Название стандарта
Название Стандарта (в том числе и файла) должно отражать тип и полное наименование Стандарта в соответствии с принятой классификацией СТО.
Пример: СТО УП «Классификатор инвестиционно-строительных проектов», либо СТО ФД «Акт приема-передачи документации».
4.2. Общие требования
4.2.1. За основу Стандарта необходимо брать готовый шаблон из СТО УП «Реестр шаблонов для создания стандартов организации» того типа (кроме СТО ФД), который планируется разрабатывать.
4.2.2. Страницы текста Стандарта должны соответствовать формату А4 со следующими размерами полей: верхнее и нижнее 20 мм, правое 15 мм, левое 30 мм. Допускается применение отдельных листов формата А3 при наличии таблиц и (или) иллюстраций данного формата.
4.2.3. Заголовки в тексте Стандарта должны создаваться с помощью стандартных стилей MS Word для того, чтобы автоматически формировалась навигация по документу.
4.2.4. Цвет текста должен быть черным, выполнен шрифтом Times New Roman с кеглем 12 и выравниванием по ширине. Значение интервала между строками должно быть 1,15, а между абзацами «До» и «После» необходимо выставить 0 (кроме заголовков Стандарта).
4.2.5. Рекомендуется умеренное использование компьютерных возможностей акцентирования внимания на определенных элементах текста Стандарта (термины, формулы и т.п.), используя шрифты разной гарнитуры.
4.2.6. При разработке Стандарта необходимо соблюдать равномерную плотность и контрастность изображений по всему тексту. Иллюстрации должны быть четкие и читаемые.
4.3.1. Заголовки структурных элементов Стандарта следует располагать к левому краю страницы (без абзацного отступа) без точки в конце и печатать прописными буквами не подчеркивая.
4.3.2. Основную часть Стандарта следует делить на разделы, подразделы и пункты. Пункты, при необходимости, могут делиться на подпункты. При делении текста Стандарта на пункты и подпункты необходимо, чтобы каждый пункт содержал законченную информацию.
4.3.3. Подразделы и подпункты следует нумеровать арабскими цифрами и записывать с абзацного отступа со значением 1,25 см.
Разделы должны иметь порядковую нумерацию в пределах всего текста, за исключением приложений и выравниваться по левому краю.
Пример: 1., 2., 3. и т.д.
Номер подраздела или пункта включает в себя номер раздела и порядковый номер подраздела или пункта, разделенные точкой. Подпункты оформляются по такому же принципу.
Пример: 1.1., 1.2., либо 1.1.1., 1.1.2. и т.д.
После номера раздела, подраздела, пункта и подпункта в тексте ставится точка.
Разделы от подразделов и подразделы между собой следует отделять одной пустой строкой.
Если раздел или подраздел имеет только один пункт или пункт имеет один подпункт, то нумеровать его не следует.
Нумерация должна быть последовательной и исключать дублирование.
4.3.4. Разделы и подразделы должны иметь заголовок, который четко и кратко отражает их содержание. Если заголовок состоит из двух предложений, их разделяют точкой.
4.3.5. Заголовки разделов пишутся прописными буквами. Подразделы, пункты и подпункты следует печатать с прописной буквы в начале.
4.3.6. Внутри пунктов или подпунктов могут быть приведены перечисления. Перед каждым элементом перечисления следует ставить дефис. При необходимости ссылки в тексте Стандарта на один из элементов перечисления вместо дефиса ставятся арабские цифры, после которых ставится скобка.
Для дальнейшей детализации перечислений необходимо использовать строчные буквы в порядке русского алфавита, начиная с буквы «а» (за исключением ё, з, й, о, ч, ъ, ы, ь)., а запись производится с дополнительного абзацного отступа как показано в примере:
Пример:
1) __________;
2) __________;
3) __________:
а) ______;
б) ______.
4.4. Нумерация страниц Стандарта
4.4.1. Страницы Стандарта следует нумеровать арабскими цифрами, соблюдая сквозную нумерацию по всему тексту. Номер страницы проставлять в центре нижней части листа без точки.
4.4.2. Иллюстрации и таблицы, расположенные на отдельных листах, включают в общую нумерацию страниц Стандарта. Иллюстрации и таблицы на листе формата А3 учитывают как одну страницу.
4.5. Иллюстрации
4.5.1. Иллюстрации (чертежи, графики, схемы, компьютерные распечатки, диаграммы, фотоснимки и т.д.) следует располагать в Стандарте непосредственно после текста, в котором они упоминаются впервые, или на следующей странице.
Использовать иллюстрации лучше в компьютерном исполнении.
На все иллюстрации должны быть даны ссылки в тексте Стандарта.
4.5.2. Чертежи, графики, диаграммы, схемы, иллюстрации, помещаемые в Стандарте, должны соответствовать требованиям государственных стандартов Единой системы конструкторской документации (ЕСКД).
4.5.3. Иллюстрации, за исключением иллюстрации приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1». Слово «Рисунок» и его наименование располагают посередине строки. Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой.
Пример: Рисунок 4.1.
4.5.4. Иллюстрации должны иметь краткое наименование и, при необходимости, пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных.
Пример: Рисунок 1 Блок-схема процесса
4.5.5. Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения.
Пример: Рисунок А.3.
4.6. Таблицы
4.6.1. Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Наименование таблицы должно отражать её содержание, быть точным и кратким. Наименование таблицы следует помещать над таблицей слева, без абзацного отступа в одну строку с ее номером через тире (рис.1).
Рисунок 1 – Общая структура таблицы
4.6.2. Таблицу следует располагать непосредственно после текста, в котором она упоминается впервые, или на следующей странице.
4.6.3. На все таблицы должны быть ссылки в тексте Стандарта. При ссылке следует писать слово «таблица» с указанием её номера.
4.6.4. Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.
Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы, разделенных точкой.
Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения.
Если в Стандарте одна таблица, то она должна быть обозначена «Таблица 1» или «Таблица B.1», если она приведена в приложении В.
4.6.5. Заголовки граф и строк таблицы следует писать с прописной буквы в единственном числе, а подзаголовки граф − со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблиц точки не ставят.
4.6.6. Допускается применять размер шрифта в таблице меньший, чем в тексте.
Горизонтальные и вертикальные линии, разграничивающие строки таблицы, допускается не проводить, если их отсутствие не затрудняет пользование таблицей.
Заголовки граф, как правило, записывают параллельно строкам таблицы. При необходимости допускается перпендикулярное расположение заголовков граф.
4.6.7. Если в таблице и (или) графах используется одинаковая единица измерения, то следует её вынесли в наименование таблицы и заголовок графа соответственно. Единицу измерения пишут после наименования через запятую.
Пример: Стоимость реализованных квартир, тыс. руб.
4.7. Примечания и сноски
4.7.1. Примечания приводят в Стандартах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала.
4.7.2. Примечания следует помещать непосредственно после текстового, графического материала или таблицы, к которым относятся эти примечания. Слово «Примечание» следует печатать с прописной буквы с абзацного отступа и не подчеркивать. Если примечание одно, то после слова «Примечание» ставится тире и примечание печатается с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами без проставления точки.
Пример:
Примечание _________________
Примечание к таблице помещают в конце таблицы под линией, обозначающей окончание таблицы.
Пример:
Примечания:
1. _________________________
2. _________________________
4.7.3. При необходимости дополнительного пояснения в Стандарте допускается оформлять его в виде сноски. Знак сноски ставят непосредственно после того слова, числа, символа, предложения, к которому дается пояснение. Знак сноски выполняют надстрочно арабскими цифрами. Допускается вместо цифр выполнять сноски звездочками «*». Применять более трех звездочек на одной странице не допускается.
Сноску располагают в конце страницы, отделяя от текста короткой горизонтальной линией слева. Сноску к таблице располагают в конце таблицы под линией, обозначающей окончание таблицы.
4.8. Формулы и уравнения
4.8.1. Уравнения и формулы следует создавать с помощью стандартных инструментов MS Word и выделять из текста в отдельную строку. Выше и ниже каждой формулы или уравнения должна быть оставлена одна свободная строка. Если уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), умножения (х), деления (:) или других математических знаков, причем знак в начале следующей строки повторяют. При переносе формулы на знаке, символизирующем операцию умножения, применяют знак «X».
4.8.2. Пояснение значений символов и числовых коэффициентов следует приводить непосредственно под формулой в той же последовательности, в которой они даны в формуле.
4.8.3. Формулы следует нумеровать порядковой нумерацией в пределах всего текста арабскими цифрами в круглых скобках в крайнем правом положении на строке.
Пример:
S=P(1+i)^t, (1)
где P сумма долга с процентами,
S сумма кредита,
t число лет,
i годовой процент в долях.
4.8.4. Формулы, помещаемые в приложениях, должны нумероваться отдельно арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (B.1).
4.8.5. Ссылки в тексте на порядковые номера формул дают в скобках.
Пример: ... в формуле (1).
4.8.6. Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (4.1).
4.9. Определения, обозначения и сокращения
Перечень должен располагаться столбцом. Слева в алфавитном порядке приводят сокращения, условные обозначения, символы, термины и т.д., справа их детальная расшифровка.
4.10. Приложения
4.10.1. Приложение оформляют как продолжение документа на последующих его листах.
4.10.2. В тексте Стандарта на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте Стандарта.
4.10.3. Каждое приложение следует начинать с новой страницы (листа) с указанием в левом верхнем углу «Приложения» и его обозначение.
Приложение должно иметь заголовок, который записывают после его номера, с разделением точкой.
4.10.4. Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Е, 3, Й, О, Ч, Ъ, Ы, Ь. После слова «Приложение» следует буква, обозначающая его последовательность.
Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О.
В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.
Если в Стандарте одно приложение, оно обозначается «Приложение А».
4.10.5. Текст каждого приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого приложения. Перед номером ставится обозначение этого приложения.
4.10.6. Приложения должны иметь общую с остальной частью документа сквозную нумерацию страниц.
