Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Про заголовки разделов
 
Добрый день.
Хотела проконсультироваться как оформлять заголовки первого уровня.
Дело в том, что в ГОСТе конкретно ничего про это не сказано.
Первая буква прописная, далее строчные - это понятно.
Какой шрифт (такой-же как основной текст 12pt или же 14pt), должен ли он быть "жирным"?
Разделы с нумерацией начинать с абзацного отступа, а вот как быть с разделами, например: "Содержание", "Лист регистрации изменений", или "Перечень использованных сокращений"? Их делать также с абзацного отступа или же центровать?
Спасибо всем!
 
Уже много писали про корпоративные стандарты. Не все строго задокументировано в Гостах. Поэтому очень многие компании имеют свой внутренний стандарт документации. Если у вас его нет, то от вас зависит как будет выглядеть ваша документация. Я бы посоветовала начать разрабатывать корпоративный стандарт, если это входит в вашу копетенцию.
А тут пишу Я - http://fortechwriters.com/
 
Сообщения восстановлены
--------------------------------------------------------------------------------

Цитата
Ана писал(а):
Уже много писали про корпоративные стандарты. Не все строго задокументировано в Гостах. Поэтому очень многие компании имеют свой внутренний стандарт документации.


Что есть внутренний корпоративный стандарт: это некая инструкция по оформлению однотипных документов, либо это действительно стандарт, который необходимо сначала разработать и потом где-то зарегистрировать, чтобы он имел силу нормативного документа?
Спасибо.

[b:21evtgl5]Ана[/b:21evtgl5]
Как правило, [b:21evtgl5]внутренний корпоративный стандарт[/b:21evtgl5] - это свод правил по оформлению документов внутри компании. В этот документ входит, все что может понадобиться при оформлении документации: внешний вид скрин шотов, шрифты, стили, правила написания названий продуктов и т.д.
Разрабатывается он самими техписами для собственного же удобства. у нас в компании рецензировался он несколькими людьми из руководства и дизайнером.
Думаю, что многие частные компании и организации сейчас отдают предпочтение внутренним стандартам нежели ГОСТам.
_________________
 


[b:21evtgl5]Nata309[/b:21evtgl5]

Не могу с Вами согласиться по поводу того, чтобы при написании предпочтение отдавалось внутренним инструкциям, а не ГОСТам.
Я за ГОСТы! И никто никогда не сможет меня упрекнуть хотя бы в одной букве.
На мой взгляд, по оформленному документу организации можно судить о том, как руководство и сотрудники относятся к нормативным документам. Если это частная компания, разрабатывающая, например, АСУ в нефтяной или газовой промышленности, пренебрегает стандартами в написании документации, то какая гарантия, что она также пренебрежительно относится к требованиям нормативных документов, например, во взрывоопасных зонах? Это моё личное мнение.
И спасибо за Ваши ответы.

Цитата
Nata309 писал(а):
Я за ГОСТы!

Да за ради бога  
Только, поймите, ГОСТ — не панацея. Он не ответит вам на все вопросы. Каждый гостовский документ вам придется затачивать под себя, тем самым создавая корпоративные стандарты, о которых вам и говорят.
Упрекать не собираюсь, но скажите мне, пожалуйста, сколько вешать в граммах?
"Абзацы в тексте начинаются отступом, равным пяти ударам пишущей машинки".
"Расстояние между заголовком и текстом при выполнении документа машинописным способом должно быть равно 3, 4 интервалам". (к сожалению, не помню из какого документа взяты цитаты)
Вы должны это знать, если оформляете по ГОСТ.




[b:21evtgl5]ЮВ[/b:21evtgl5]


Цитата
Nata309 писал(а):
Не могу с Вами согласиться по поводу того, чтобы при написании предпочтение отдавалось внутренним инструкциям, а не ГОСТам.


По поводу основного вопроса - он был задан мне в личке (ответ там же).
О взаимозаменяемости корпоративных стандартов и ГОСТов.
Если программный продукт - собственность фирмы, то документацию на него она вправе оформлять по своему усмотрению (по корпоративному стандарту или по ГОСТу) - с целью повысить конкурентноспособность изделия (например, печатать в цвете).
Если программный продукт изготовлен по заказау госучреждений или Минобороны - то документация изготавливается и оформляется по ГОСТам.
В некоторых случаях (для Минобороны) можно делать отступление от ГОСТов, но все такие случаи должны быть обязательно оговорены и согласованы (утверждены) заказчиком в специальном документе "Руководящие указания по конструированию" (см. ГОСТ В 15.213), чтобы для заказчика это не было сюрпризом
(например, заказчик ожидает документацию, образно говоря, в виде картины Иванова "Явление Христа народу" размером 10х6 м с полутора десятком детально прописанных лиц, а вы предлагаете её в виде "Черного квадрата" Малевича).

[b:21evtgl5]Nata309[/b:21evtgl5]
Спасибо за Ваши ответы.
После фразы господина ЮВ о том, что:
"Если программный продукт изготовлен по заказу госучреждений или Минобороны - то документация изготавливается и оформляется по ГОСТам" - скажу, это наш случай.
Спасибо всем ещё раз (отдельное спасибо ЮВ).
 
Если программный продукт - собственность фирмы, то документацию на него она вправе оформлять по своему усмотрению (по корпоративному стандарту или по ГОСТу) - с целью повысить конкурентноспособность изделия (например, печатать в цвете).
Если программный продукт изготовлен по заказау госучреждений или Минобороны - то документация изготавливается и оформляется по ГОСТам.
В некоторых случаях (для Минобороны) можно делать отступление от ГОСТов, но все такие случаи должны быть обязательно оговорены и согласованы (утверждены) заказчиком в специальном документе "Руководящие указания по конструированию" (см. ГОСТ В 15.213), чтобы для заказчика это не было сюрпризом

============================

:oops:  :oops:  :oops: !!!!!
Очень-очень пригодится вот эта информация!!!
А...ссылочку - где это затверждено (в каком ГОСТе..?)  - может кто-нибудь  сможет указать?
 
Вообще-то ни аннотация ни содержание разделами не являются (это к 1-му сообщению).
Обычно (т.е. так делалось неоднократно и принималось  заказчиком)- текст по центру, шрифт 14. Жирный не жирный не важно.
Страницы: 1
Читают тему