Главная
Wiki
wiki
С чего следует начинать техническому писателю?

С чего следует начинать техническому писателю?

Wiki для разработчиков технической документации

Чтобы стать редактором Wiki оставьте заявку в произвольной форме на форуме

С чего следует начинать техническому писателю?

Прочитать раздел Wiki : Базовая квалификация технического писателя
Пройти обучение
Зарегистрироваться и задавать вопросы на форуме технических писателей
Прочитать книги

0 writer 17.02.2014 19:50:20
Уважаемые технические писатели! Давайте обсудим эту статью на Wiki с чего следует все-таки начинать техническому писателю? Ваше мнение?

1 elanor 18.02.2014 09:45:33
Ну как с чего.. с изучения стандартов и регламентов, по которым ему предстоит писать эту самую документацию. По поводу "прочитать книги", я бы рекомендовала: Ю.В. Кагарлицкий "Разработка документации пользователя программного продукта" В. Глаголев "Разработка технической документации" - тут просто хорошая выжимка из всех российских стандартов, хотя лично мне из этой книги пригодились реально пара глав, от силы. Если собрались переводить или писать руководства на английском, то Microsoft Manual of Style это просто must read.

ADVANCED 18.02.2014 10:38:30

Цитата
elanor пишет: Ну как с чего.. с изучения стандартов и регламентов, по которым ему предстоит писать эту самую документацию.

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

0 elanor 18.02.2014 10:49:45
Так вот эти стандарты компании также входят в список для изучения =) Я, например, пишу в крупной фирме с кучей отделов, в каждом отделе своя документация. У нас на всех единый формат и единый регламент подготовки документации.

ADVANCED 18.02.2014 10:51:52

Цитата

elanor пишет:
Так вот эти стандарты компании также входят в список для изучения =)
Я, например, пишу в крупной фирме с кучей отделов, в каждом отделе своя документация.
У нас на всех единый формат и единый регламент подготовки документации.

Мертвого уговорите!

С этого можно начинать, но не с ГОСТов.

0 writer 18.02.2014 12:40:16
Согласен, ГОСТы могут отбить все желание быть техписом)

0 MarMak 21.03.2018 15:55:32
Я начинала с написания художественной литературы. Работала "литнегром" у блогеров, влогеров и писателей. Нужно заинтересовать тех.пользователя словом. Чем оно будет проще, тем лучше.) Стандарт должен быть, учитывая, что организации типа Минпромторга без ГОСТов документ даже рассматривать не станут. Но внутренняя документация и руководства - вполне могут иметь собственную, корпоративную унификацию.

MarMak 21.03.2018 15:57:31

Цитата

MarMak пишет:
Я начинала с написания художественной литературы. Работала "литнегром" у блогеров, влогеров и писателей. Нужно заинтересовать тех.пользователя словом. Чем оно будет проще, тем лучше.) Стандарт должен быть, учитывая, что организации типа Минпромторга без ГОСТов документ даже рассматривать не станут. Но внутренняя документация и руководства - вполне могут иметь собственную, корпоративную унификацию.

"...вполне может... - вместо "...вполне могут..." - простите, была испугана(с). Допустила некорректность.

Зарегистрируйтесь