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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Ссылка на термин в документе, Как правильно оформить в тексте инструкции термин из раздела "Термины и ...
 
Задолбало меня СМК. Как правильно написать в документе термин, находящийся в оазделе термины и определения? ГОСТов, как термины писать, полно. А сослаться ... нигде не могу найти.
 
Имелось в виду, текст типа "При работе программист использует руки..."  
Было написано:  "При работе программист (номер подпункта из раздела терминов) использует руки..."
Как же люди, Вы пишете?
 
Цитата
Гость пишет:
Как правильно написать в документе термин, находящийся в оазделе термины и определения?
Строго на русском языке, без ошибок, в соответствии с последовательностью букв в термине. Также можно склонять и использовать во множественном числе  ))))  

Цитата
Гость пишет:
Было написано:"При работе программист (номер подпункта из раздела терминов) использует руки..."
Бред.  Вместо того, что бы заниматься разработкой продукта и документации, вы страдаете х{censored}нёй и протираете штаны )
 
Я сейчас пишу руководство разработчика, в котором изначально все было в куче: определение и описание понятий, инструкции по настройке в системе.
Всю "понятийную" часть я выделила в отдельный документ. Сейчас решила сделать HTML-справку, в которой будет содержаться описание основных понятий модуля и гиперссылки между описаниями.
Если вы пишете в ворде, то, на вашем месте, я составила бы в конце документа указатель.
techwriter.ru.com
 
Я все про себя знаю. У меня есть СМК, которой вот из-за этого я не могу сдать документ. Но на вопрос то так никто и не ответил. Документ в Word на соответствие всем ГОСТам проверен. Если конкретно помочь нечем, то не высказывайтесь, плиз
 
Я не даю ссылку вообще. Подразумевается, что пользователь, при необходимости, заглянет в раздел с терминами и без ссылки. Это аналогично обозначениям и сокращениям в документе, у каждого сокращения мы же не даем ссылку на перечень сокращений. СМК по этому поводу ни разу не придиралось ко мне.
А если СМК не знает как правильно, то пусть принимает то, что сделал разработчик документа. :)
 
Цитата
sonriza пишет:
Я не даю ссылку вообще. Подразумевается, что пользователь, при необходимости, заглянет в раздел с терминами и без ссылки. Это аналогично обозначениям и сокращениям в документе, у каждого сокращения мы же не даем ссылку на перечень сокращений. СМК по этому поводу ни разу не придиралось ко мне.
А если СМК не знает как правильно, то пусть принимает то, что сделал разработчик документа.  :)
Один раз я писала технический отчет о выполненных работах. Технический отчет, конечно же, содержал понятия, которые, как мне казалось, должен знать сотрудник ИТ департамента. Меня в итоге попросили расписать каждый термин прям в тексте, сразу после его употребления. Сказали, что читать будут нетехнические специалисты, а лезть в отдельный раздел с терминами и определениями им неохота.
techwriter.ru.com
 
Большое спасибо всем, кто ответил. Написала новый вариант с простыми русскими буквами согласно правилам русского языка без ссылок.  Но вот просматривала те же СМКшные ГОСТы - там в некоторых доках термины, включенные в раздел "Термины...", в тексте выделены жирным шрифтом. Может, случайно, кто-нибудь знает, почему это?
 
Цитата
Гость пишет:
Большое спасибо всем, кто ответил. Написала новый вариант с простыми русскими буквами согласно правилам русского языка без ссылок. Но вот просматривала те же СМКшные ГОСТы - там в некоторых доках термины, включенные в раздел "Термины...", в тексте выделены жирным шрифтом. Может, случайно, кто-нибудь знает, почему это?
А вы по какому ГОСТу пишете?
Давайте я вам напишу выдержками из ГОСТ 2.105 все, что касается терминологии (может, пригодится?):
Цитата


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

Цитата
4.2.3 В тексте документа не допускается:
- применять обороты разговорной речи, техницизмы, профессионализмы;
- применять для одного и того же понятия различные научно-технические термины, близкие по смыслу
(синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском
языке;
Если есть сокращения:

Цитата
Если в документе принята особая система сокращения слов или наименований, то в нем должен быть
приведен перечень принятых сокращений, который помещают в конце документа перед перечнем терминов.
techwriter.ru.com
 
Спасибо я именно по ГОСТ 2.105 и пишу. А вчера мне СМК предложило писать в тексте документа слова из раздела терминов с прописной буквы. Ну тут уже они были мной попрошены показать, из какого документа это взято.
Страницы: 1
Читают тему