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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Как правильно составлять список сокращений и терминов
 
Уважаемые коллеги.
1) Прошу подсказать: как правильно составлять перечень сокращений и терминов?
Туда нужно выносить только то, что встречается по тексту документа?
Пример, в тексте встретилось сокращение HTML. При его расшифровке сразу всплывают такие понятия как браузер или веб-страница (которых в самом тексте документа нет).
Нужно ли описывать эти новые понятия (браузер, веб-страница)? Это ведь может быть бесконечный процесс…

2) И еще:

Этот список должен быть одинаковым для всех документов комплекта (и для пояснительной записки, и для описания программного обеспечения), или нужно его редактировать под каждый документ?
Так как в пояснительной записке терминов и сокращений больше чем в том же описании ПО. Как правильно?
Буду очень благодарна за ответ.
 
Цитата
Пример, в тексте встретилось сокращение HTML. При его расшифровке сразу всплывают такие понятия как браузер или веб-страница (которых в самом тексте документа нет).
Нужно ли описывать эти новые понятия (браузер, веб-страница)?
Отвечу по первому, если пишите для полных идиотов, то тогда потребуется расшифровывать все  :) , а вообще расшифровка идет в зависимости от того, для кого документация предназначена (лузер, профи и т.д.)
Работаю по-старинке...
 
по второму: для комплекта документации должен быть единый перечень определений/терминов и сокращений
 
Ася разобрались со списками?
 
Цитата
'Ася' пишет:
Пример, в тексте встретилось сокращение HTML. При его расшифровке сразу всплывают такие понятия как браузер или веб-страница (которых в самом тексте документа нет).
Ну для начала, в расшифровке совсем не встречаются понятия такие как браузер или веб-страница. Это язык разметки документов. Стараясь "правильно" составить перечень сокращений, вы больше запутаетесь или запутаете читателя. Веб-страница - на то она и веб, чтобы открывалась в веб. А файл *.html можно открыть/прочесть локально, не подключаясь к сети и не имея браузера..


Цитата
гена пишет:
Отвечу по первому, если пишите для полных идиотов, то тогда потребуется расшифровывать все , а вообще расшифровка идет в зависимости от того, для кого документация предназначена (лузер, профи и т.д.)
Для полных идиотов надо писать ТРЕБОВАНИЯ К КВАЛИФИКАЦИИ ПЕРСОНАЛА. В которых указывать, что пользователь должен обладать начальными навыками работы в ПК, уметь пользоваться клавиатурой и мышью и далее в зависимости от уровня "идиотизма" пользователя. В случае с ПО с веб-интерфейсом можно написать, что пользователь должен иметь представление о работе с браузером, веб-страницами и т.п.

И все!!! Не значешь что такое HTML - закрой книжку и вали на курсы оператора ПК!


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

На мой взгляд, минимум нужно перечислить только аббревиатуры, которые непосредственно относятся к данному продукту, например, выдуманы разработчиками или те, которые могут пониматься двояко (типа ЦП - цифровая подпись или цифровой предобразователь).
 
Задача Технического писателя написать руководство по системе, а не очередную никому не нужную энциклопедию терминов. Поверьте, литературы с описанием аббревиатур и IT-сленга достаточно.
 
Цитата
'Ася' пишет:
И еще:

Этот список должен быть одинаковым для всех документов комплекта (и для пояснительной записки, и для описания программного обеспечения), или нужно его редактировать под каждый документ?
Список должен быть одинаково актуальным. Но состав терминов должен соответствовать отдельному документу.  Т.е. не должно быть описания термина, которого нет в тексте.
 
всем помогающим- большое человеческое спасибо...

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

т.е. как-то так: лист утверждений, титульный лист ПЗ, текст ПЗ, титульный лист описание программного обеспечения, текст описания ПО и т.д и т.п. и в конце перечень терминов и лист изменений.

Или должно быть так: лист утверждений, титульный лист ПЗ, текст ПЗ, перечень всех терминов, лист изменений; титульный лист описание программного обеспечения, текст описания ПО, перечень всех терминов,лист изменений и т.д.

Если подскажете, где посмотреть правила оформления пояснительной записки  (когда пояснительная записка из нескольких документов сшивается в одну книгу - буду очень признательна).
Где-то я видела- но никак не найду где.  
 
ADVANCED, к сожалению, сразу не увидела ваше сообщение:
"Список должен быть одинаково актуальным. Но состав терминов должен соответствовать отдельному документу.  Т.е. не должно быть описания термина, которого нет в тексте"- да, наверное это более логично, чем "захламлять" документ лишними терминами...
тогда остается вопрос только по комплектации ( если все сшивать в одну книгу: оставлять один общий список или после каждого документа приводить свой).
 
Если не заморачиваться ГОСТами, а делать для людей, удобнее было бы делать отдельный раздел сайта/файл/документ, на который ссылаться откуда угодно.
 
Цитата
'Ася' пишет:
тогда остается вопрос только по комплектации ( если все сшивать в одну книгу: оставлять один общий список или после каждого документа приводить свой).
Можно в РП (или что у вас там главным будет) сделать полный список, а в остальных документах в разделе "термины и определения" указать, что "полный перечень терминов и определений приведен в документе 1111.Руководство пользовател, в п. 1.2.". Тем самым раздел остается в каждом документе, а список не дублируется. Это не запрещено ГОСТами.
Изменено: ADVANCED - 21.10.2013 18:40:42
 
Спасибо!!
Страницы: 1
Читают тему