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

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

wiki → С чего следует начинать техническому писателю?  
Чтобы стать редактором Wiki оставьте заявку в произвольной форме на форуме 



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



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


Это нравится:0Да/0Нет

Это нравится:0Да/0Нет
writer
Уважаемые технические писатели! Давайте обсудим эту статью на Wiki с чего следует все-таки начинать техническому писателю? Ваше мнение?
Это нравится:1Да/0Нет
elanor
Ну как с чего.. с изучения стандартов и регламентов, по которым ему предстоит писать эту самую документацию.
По поводу "прочитать книги", я бы рекомендовала:
  • Ю.В. Кагарлицкий "Разработка документации пользователя программного продукта"
  • В. Глаголев "Разработка технической документации" - тут просто хорошая выжимка из всех российских стандартов, хотя лично мне из этой книги пригодились реально пара глав, от силы.
  • Если собрались переводить или писать руководства на английском, то Microsoft Manual of Style это просто must read.
Это нравится:0Да/0Нет
ADVANCED
Цитата
elanor пишет:
Ну как с чего.. с изучения стандартов и регламентов, по которым ему предстоит писать эту самую документацию.
Вот с ГОСТов вообще не следует начинать, ими пользуются (или их требуют) только фанаты-извращенцы.
У меня сложилось мнение, что чем больше влияние ГОСТов на документацию, тем меньше зарплата. В крупных компаниях разрабатывают свои стандарты.
Это нравится:0Да/0Нет
elanor
Так вот эти стандарты компании также входят в список для изучения =)
Я, например, пишу в крупной фирме с кучей отделов,  в каждом отделе своя документация.
У нас на всех единый формат и единый регламент подготовки документации.
Это нравится:0Да/0Нет
ADVANCED
Цитата
elanor пишет:
Так вот эти стандарты компании также входят в список для изучения =)
Я, например, пишу в крупной фирме с кучей отделов, в каждом отделе своя документация.
У нас на всех единый формат и единый регламент подготовки документации.
Мертвого уговорите!

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