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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 След.
RSS
Как правильно оформлять список?
 
1. Собственно можно ли использовать точки вместо тире?
2. Какое растояние от края до тире? От тире до текста?
                   2.1 Широкое тире или маленькое?
                             - когда какое?
3. В каких случаях используются: 1 ,  1) ,  -  ,  --  ,  а  ,  а)  , жирная точка.

Пишу руководство оператора для ПП по ГОСТ 19.*** 1978 года. пишу в Word 2003.

Ткните на нормативный документ плиzz.
 
ГОСТ 19.106-78
Единая система программной документации. Требования к программным документам, выполненным печатным способом

http://www.dbases.ru/cgi-bin/catalog/ca ... 32437&pr=1

Мы у себя на предприятии через СТП провели решение, об оформлении программных документов, выполненным печатным способом в соответствии с ГОСТ 2.105-95
Единая система конструкторской документации. Общие требования к текстовым документам. С учетом последних изменений он самый современный. Учитывает особенности проектирования текстовых документов в программах типа Word.
http://www.dbases.ru/cgi-bin/catalog/ca ... =5378#5379

Т.е. форма документа по ГОС 19.106, а внутреннее содержание оформляем по ГОСТ 2.105.

Это позволило нам унифицировать требования к стилевому оформлению как конструкторских, так и программных, и технологических документов.
Человек стал человеком благодаря воображению, а вовсе не труду
 
Спасибо.
Но всё же не понятно, можно ли использовать жирные точки... В ветвистом списке как-то не особо удобно использовать "тире" и цифры (буквы) со скобками. Не всегда в таком ветвистом списке нужно перечисление типа 1);.... 2)...... и т.д.
Руководству не особо нравится использование списков в виде 1);.... 2)...... и т.д. , но и точки типа не по госту. :shock: Что делать..., ума не приложу. :?
 
ГОСТ устанавливает общие (основные) требования. СТП конкретизирует, исключает двойное толкование некоторых формулировок ГОСТ (что к сожелению встречается) и устанавливает корпоративные требования (основанные на ГОСТ). Теперь дело за Вами, zz_top. Беритесь за перо, пишите СТП (СТО) и оговорите в нем требования к оформлению, в том числе, перечислений. Ведь WORD тоже проектировался не от былды и в его основе лежат документы стандартизирующие соответствующие правила к оформлению документов, а не анархия или художничество.
(Анархия и программирование вообще вещи помоему несовместимые).
Иными словами, влияние нормативных требований (в мировом понимании) к оформлению документации столь велико, что нетрудно заметить и на других программных реализациях текстовых редакторов.
zz_top, возможно вы станете первын стандартизатором в своей фирме в области продвижения соотвествующих решений.
Не ждите, что кто-то за Вас это решит.
P.S. Встав на тернистый путь стандартизации учтите, что на лавлах почивать не придется. Т.к. найдется масса поводов скрестить шпаги в отстаивании этих самых - корпоративных стандартов (СТП).
Если Вы этого боитесь, тогда тупо следуйте требованиям ГОСТ или будете вечно "пугливо" озираться и испрашивать разрешения, "при попытке заменить тире на точку".
Человек стал человеком благодаря воображению, а вовсе не труду
 
Цитата
... СТП конкретизирует, исключает двойное толкование некоторых формулировок ГОСТ (что к сожелению встречается) и устанавливает корпоративные требования (основанные на ГОСТ).

Если СТП устанавливает  корпоративные требования, основанные на ГОСТ (не расширяющие требования ГОСТ, например, принятый в конторе порядок обозначения документации), то считается, что документация  выполнена по ГОСТ.

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

Других вариантов нет.
Нельзя быть немного беременной.

Свои СТП вы можете сочинять вообще от балды, не принимая во внимание существование каких-то ГОСТов.

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

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

Так что для элементов списка можете  выбрать
1),   а), -, ., * , римская цифра), галочка, кружок, квадратик, пиктограмма и т. п.
 
Цитата
Если программный продукт (изделие) - собственная разработка конторы.
В том то и дело!!!! ... всё своё! Это практически мои слова, но мне как-то не верят, блин, ...типа: "...а где написано что можно не придерживаться госта? Где???" Я -- да фиг его знает  :?:   :!:  Мне - Так отож...  :)
 
Цитата
Где?
В Федеральном законе о техническом регулировании № 184-ФЗ от 27 декабря 2002 года.

Понятие технического регламента введено Федеральным законом о техническом регулировании № 184-ФЗ от 27 декабря 2002 года. Закон разделил понятия технического регламента и стандарта, установив добровольный принцип применения стандартов. Технические регламенты, в отличие от них, носят обязательный характер, однако могут устанавливать только минимально необходимые требования в области безопасности, причем приниматься они могут только в определенных целях, а именно:
  • •защиты жизни или здоровья граждан, имущества физических или юридических лиц, государственного или муниципального имущества;
  • •охраны окружающей среды, жизни или здоровья животных и растений;
  • •предупреждения действий, вводящих в заблуждение приобретателей.
На переходный период, до принятия необходимых технических регламентов, с указанными целями должны применяться соответствующие требования ранее принятых ГОСТ (ГОСТ Р), санитарных и строительных норм и правил (СНиП, СанПиН).

Т. к. документация на ПО не угрожает жизни граждан(если, конечно, не бить толстенной книгой по голове), то, имхо, и указанное требование использовать в переходный период ГОСТы к нам не относится.
Статья 12. Принципы стандартизации

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

Статья 17. Стандарты организаций

1. Стандарты организаций, в том числе коммерческих, ... могут разрабатываться и утверждаться ими самостоятельно исходя из необходимости применения этих стандартов для целей, указанных в статье 11 настоящего Федерального закона, для совершенствования производства и обеспечения качества продукции, выполнения работ, оказания услуг, а также для распространения и использования полученных в различных областях знаний результатов исследований (испытаний), измерений и разработок.
Порядок разработки, утверждения, учета, изменения и отмены стандартов организаций устанавливается ими самостоятельно с учетом положений статьи 12 настоящего Федерального закона.
 
Ооо!!! Спасибо ЮВ!!!  :D  
Это убедило!!! Спасибо за помощь!
Теперь гораздо спокойнее стало работать!
Полное убеждение произошло по фразе:
"обеспечение конкурентоспособности и качества продукции..." -Статья 11
Это и был тот самый "гвоздик"  :)
Спасибо всем!
 
Цитата
...Полное убеждение  произошло по фразе:...

Это называется "Момент истины"
(есть такой очень увлекательный роман Богомолова "Момент истины
(В августе сорок четвертого").
 
Освежу тему, поскольку возник вопрос по оформлению маркированных списков с помощью тире (дефисов).

По ГОСТ 2.105, п. 4.1.7, "Перед каждой позицией перечисления следует ставить дефис"
По ГОСТ 19.106, п. 2.1.6, "Допускается выделять перечисления простановкой дефиса перед текстом"

Но ведь дефис - орфографический знак, выходит, маркировать списки дефисом неправильно?
Мы маркируем коротким тире, однако периодически возникают трения... Покопалась на Грамоте, тоже рекомендуют в данном случае использовать тире.
В итоге кто прав? ГОСТ или русский язык? Или, может, я вообще вопрос не так ставлю?  :(
 
Цитата
В итоге кто прав? ГОСТ или русский язык? Или, может, я вообще вопрос не так ставлю?  :(
Всегда прав ГОСТ, это 100% для гос.организаций которые пишут по ГОСТ
 
Цитата
Всегда прав ГОСТ, это 100% для гос.организаций которые пишут по ГОСТ
Для всех, кто требует документацию по ГОСТ, главное ГОСТ. Там может быть написан полный бред не по теме или история про Красную шапочку, никто на это не обратит внимание. Проверял пару раз  :mrgreen:
Староверам достаточно наличия русских букв в любой последовательности.
 
Цитата
Цитата
Всегда прав ГОСТ, это 100% для гос.организаций которые пишут по ГОСТ
Для всех, кто требует документацию по ГОСТ, главное ГОСТ. Там может быть написан полный бред не по теме или история про Красную шапочку, никто на это не обратит внимание. Проверял пару раз  :mrgreen:
Староверам достаточно наличия русских букв в любой последовательности.
Я тоже не так давно общался с нормоконтролером, когда разрабатывал стандарт предприятия на оформление ЭД.
Говоришь ему, что ГОСТ противоречит правилам русского языка. А ему пофик — ведь ГОСТ же. Так и не получилось договориться по ряду пунктов.
 
Цитата
Цитата
Цитата
Всегда прав ГОСТ, это 100% для гос.организаций которые пишут по ГОСТ
Для всех, кто требует документацию по ГОСТ, главное ГОСТ. Там может быть написан полный бред не по теме или история про Красную шапочку, никто на это не обратит внимание. Проверял пару раз  :mrgreen:
Староверам достаточно наличия русских букв в любой последовательности.
Я тоже не так давно общался с нормоконтролером, когда разрабатывал стандарт предприятия на оформление ЭД.
Говоришь ему, что ГОСТ противоречит правилам русского языка. А ему пофик — ведь ГОСТ же. Так и не получилось договориться по ряду пунктов.

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

Правила русского языка - это тоже, своего рода, стандарт, хотя и неписанный.  :D
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Цитата
Цитата
Всегда прав ГОСТ, это 100% для гос.организаций которые пишут по ГОСТ
Для всех, кто требует документацию по ГОСТ, главное ГОСТ. Там может быть написан полный бред не по теме или история про Красную шапочку, никто на это не обратит внимание. Проверял пару раз  :mrgreen:
Староверам достаточно наличия русских букв в любой последовательности.
Я тоже не так давно общался с нормоконтролером, когда разрабатывал стандарт предприятия на оформление ЭД.
Говоришь ему, что ГОСТ противоречит правилам русского языка. А ему пофик — ведь ГОСТ же. Так и не получилось договориться по ряду пунктов.

Та же история. И с нормоконтролем  :cry: , и даже иногда с заказчиками.  :roll:
Жаль, лишний раз убедилась в том, что формализм побеждает здравый смысл.
 
Цитата
Цитата
Цитата
Устаревший ГОСТ - это лишний повод придраться. Но, ничего не поделаешь., по возможности, приходится выполнять.
Я сейчас не говорю про его старость. Я говорю про то, что ГОСТ местами противоречит правилам русского языка, а это уже ни в какие ворота не лезет. Уже только за это его нельзя использовать.

Правила русского языка - это тоже, своего рода, стандарт, хотя и неписанный.  :D

Очень даже писаный  :lol: , вон у меня сколько на работе справочников-словарей-учебников, не говоря уже о ресурсах в сети. Только нормоконтроль непобедим, и ему аргументы вроде "Мы должны передавать заказчику грамотно составленную документацию" - и не аргументы вовсе. Сразу тычут пальчиком в ГОСТ, в общеизвестный косяк, и все... Написано пером... Извольте исправлять на дефисы.
 
Цитата
Правила русского языка - это тоже, своего рода, стандарт, хотя и неписанный.  :D
Очень даже писаный   , вон у меня сколько на работе справочников-словарей-учебников, не говоря уже о ресурсах в сети. Только нормоконтроль непобедим, и ему аргументы вроде "Мы должны передавать заказчику грамотно составленную документацию" - и не аргументы вовсе. Сразу тычут пальчиком в ГОСТ, в общеизвестный косяк, и все... Написано пером... Извольте исправлять на дефисы.

Я имею в виду, что все эти справочники - есть частные мнения, хотя и, несомненно, грамотных, и ученых людей - специалистов по лингвистике.
Есть определенные авторитеты в этом вопросе, но и они основываются на неких нормах, имеющих место в общественной культуре.
Например, недавно "разрешили" говорить "мое кофе", хотя многие так и говорили всегда, а другие с этим несогласны.  :D  
Признается нормативным "йогУрт", хотя почти никто так не говорит и т.д.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Сразу тычут пальчиком в ГОСТ
А почему в ГОСТ, а не в справку MS Word, Wikipedia или еще какой-нибудь источник с примерами и общепринятой практикой?
 
Цитата
А почему в ГОСТ, а не в справку MS Word, Wikipedia или еще какой-нибудь источник с примерами и общепринятой практикой?

Госзаказчики у нас, посему в ГОСТ.
 
Цитата
Цитата
А почему в ГОСТ, а не в справку MS Word, Wikipedia или еще какой-нибудь источник с примерами и общепринятой практикой?

Госзаказчики у нас, посему в ГОСТ.

А вот сейчас, только что, заказчик сказал нам, что ГОСТ имеет рекомендательный характер.  :o  Просят переделать под их требования.
Тоже, кстати, государственная организация.
У них ГОСТ "противоречит корпоративным стандартам". :o
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
А вот сейчас, только что, заказчик сказал нам, что ГОСТ имеет рекомендательный характер.  :o  Просят переделать под их требования.
Тоже, кстати, государственная организация.
Иметь собственные требования к продукции и корпоративные стандарты, знать как нужно делать и что требовать от исполнителя - это очень хорошее качество организации-заказчика. Сейчас даже менеджеры всем известной "Почта России" стараются поднять имидж, меняя столетние устои и никому не нужные стандарты, лишь бы не обанкротить.

В отрасли с непонятными ГОСТами и устоями, на вопрос "Как правильно оформлять список?" скорее ответит тот, кто платит деньги писателю за это оформление и кто берет за это ответственность  :mrgreen: .  
Нормоконтролеры тоже разные бывают. Может их проще переубедить, чем выполнять противоречащие дурацкие требования. Ну или сменить место работы, где скажут четко как делать.
 
Цитата


А вот сейчас, только что, заказчик сказал нам, что ГОСТ имеет рекомендательный характер.  :o  Просят переделать под их требования.
Тоже, кстати, государственная организация.

ГОСТ имеет рекомендательный характер до того момента, пока его явно не укажут в ТЗ: "Документация должна соответствовать требованиям ГОСТ №..." Шаг влево, шаг вправо - побег с неминуемым расстрелом. А у нас еще и корпоративный стандарт, который кусочно-непрерывно пожевывает самые разные ГОСТы...

Наши заказчики очень любят ГОСТ, а нормоконтроль и подавно. Были у нас победные моменты, когда удавалось переубедить нормоконтролера, но, к сожалению, на общем фоне это мелочи. Типа того, что слово "вуз" мы будем писать строчными буквами и все тут, или гигабайт сокращать (кстати, по ГОСТу) - ГБ.
Оформление списка не проходит пока. Стоят насмерть. И ладно бы еще дефис, но вот была история с использованием нумерованных списков.. вспомнишь - вздрогнешь.
 
Цитата


В отрасли с непонятными ГОСТами и устоями, на вопрос "Как правильно оформлять список?" скорее ответит тот, кто платит деньги писателю за это оформление и кто берет за это ответственность

К сожалению, пока так и есть. А как же истина?  :cry:
Страницы: 1 2 След.
Читают тему