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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Советы начинающим техническим писателям
 
Коллеги,  поделитесь секретами с начинающими техническими писателями в этой теме. Какой бы вы сами хотели услышать совет в начале своей карьеры.
 
Мой совет такой, добыть правдами и неправдами какой-нибудь "корпоративный стандарт для написания документации", желательно хорошей софтверной компании и изучить его, это будет одним из первых шагов. Почитать книжку "Д. Э. Розенталь. Справочник по правописанию и стилистике"
Работаю по-старинке...
 
Почитать Дэйла Карнеги "Как завоевать друзей" ибо работать с программистами ох как не просто. :D
 
1. Прочитать книгу Ю.Кагарлицкого "Метагайд — руководство по составлению руководств".
2. Читать больше художественной литературы (классической, не одноразовых "бумажных" книжек) для приобретения стилистической культуры речи. )
 
Цитата
2. Читать больше художественной литературы (классической, не одноразовых "бумажных" книжек) для приобретения стилистической культуры речи. )

По моему мнению, важнее читать больше технической литературы по специальности для освоения терминологии и технических штампов, принятых в данной сфере деятельности.
По моему опыту, от технического писателя отнюдь не требуется способность к литературному творчеству. Все должно быть предельно кратко, четко и логично, грамотно, красиво оформлено, с достаточным количеством картинок. В идеале пользователь должен взять документацию и относительно легко воспроизвести описанное в ней.
Хотя, может быть, в разных отраслях может быть различное отношение к этому. Например, при описании программных продуктов, предназначенных непосредственно для частных лиц (компьютерные игры?), неплохо, если еще будет описано и интересно.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Alex_Gur
Терминология и технические штампы осваиваются быстро при внедрении в ту или иную сферу деятельности, но ими "не залатать" стилистическую безграмотность и косноязычие - "что вижу, то пишу".. а читать опусы таких вот горе-писателей бывает смешно и стыдно ))
 
Я в начале ориентировался на Майкрософт, все-таки они уже давно выпускают документацию и знают в этом толк.
 
Если для госструктур работаете - посмотри эту книжку: http://teh-doc.narod.ru/p_ogl_1.html
Там подробно по стандартам расписано и примеры есть.
 
Цитата
Если для госструктур работаете - посмотри эту книжку: http://teh-doc.narod.ru/p_ogl_1.html
Там подробно по стандартам расписано и примеры есть.
это ваша книжка?
 
Да. "Выжимка" из ГОСТ 2, 7, 19, 21, 34 серии с комментариями, рекомендациями, примерами - все, что нужно для техписа при разработке документов на АС.
 
Ну а прежде всяких ГОСТ, терминов и т.п. -
Правила русской орфографии и пунктуации!!!
Скачать можно здесь: http://teh-doc.narod.ru/p_spravochnik.html
 
Однажды на лугу зеленом
Коровам, овцам и козе
Осёл, что слыл большим учёным,
Своё представил экспозе:

«Интеллигибельный анамнез
Антропонимов подтвердил,
Что аменабельность инверсий
У конвергентных интеграций
Суть амблиопии диагноз
Амбивалентных асферил.
Тем более без инспираций
В амплификации прогрессий
Интерпелляция – не базис,
Как я уже и говорил».

И сборище заголосило:
«Умно! Блестяще! Браво! Бис!»
Все думали, осёл – светило,
А был он просто аферист.

Таких «ученых» пруд пруди.
Запомни: настоящий умный
Не выражается заумно,
А смысл стремится донести
.
Изменено: ADVANCED - 02.04.2014 10:10:27
Страницы: 1
Читают тему