Клуб технических писателей

Обучение специальности

firstbon
23 октября 2015, 13:47

Добрый день!

Прошу извинить, если это неподходящее место для таких просьб.

Я хочу поменять свою профессию и стать разработчиком технической документации. Думаю, что у меня может получиться, но пока слишком мало знаю об особенностях этой работы  − не знаю, с чего начать. Было бы здорово поговорить с кем-то из действующих технических писателей.

Свяжитесь со мной: я внимательно выслушаю тяжёлую историю вашей жизни.

Спасибо!


 

7 комментариев
Подписаться на комментарии к посту

Хм...

Сначала задайтесь вопросом: "Когда TWR пишет документацию, кто должен инициировать контакт в связке dev team members - TWR?" и попробуйте ответить на него. Можете написать ваш ответ здесь.

После этого вам станет понятно, как переформулировать ваш изначальный пост/просьбу здесь.

Инициировать контакт должен TWR.

Если я правильно понял, и вы имеете ввиду, что технический писатель при проблеме должен сам обращаться к разработчикам.

Дело в том, что я не нашёл способа получить контакты тех, кто подписан на этот клуб, поэтому так сформулировал свой пост и не знаю, как лучше. Хотя мог бы попросить оставить свои контакты. Может быть вы согласитесь?

По поводу "как сформулировать пост" - сначала вам надо прочитать это:

оригинал: http://www.catb.org/esr/faqs/smart-questions.html

или перевод: http://segfault.kiev.ua/smart-questions-ru.html

Но не только применительно к этому форуму. Это текст будет полезен для любой ситуации.

После прочтения - попробуйте переформулировать ваши исходные мысли и напишите их здесь.

В какой сфере вы работаете, IT? Какое у вас образование и какая профессия на текущий момент?

Чтобы стать разработчиком технической документации, нужны определенные исходные данные. 

Спасибо, что откликнулись.
Нет, я с IT не связан. Разве только что с блогами об IT.
Образование − управление на предприятии пищевой промышленности, незаконченное.
Текущая профессия − менеджер по продажам.

Я занимаюсь этим больше пяти лет. В том числе составлял инструкции для пользователей, для руководителей проектов. На одной из вакансий разработчика технической документации увидел, что нужны примерно эти навыки, и понял, что хочу попробовать, но меня не взяли. Теперь хочу получше подготовиться и узнать об этом больше.

Может быть вы посоветуете какую-то литературу?

Список литературы есть в этом посте: http://clubs.ya.ru/x-plain/replies.xml?item_no=27


В нашей литературе есть хорошие книги про писательство в целом, но узкоспецилизированных трудов про "русскую" тех.документацию нет. Очень много литературы на английском (в том числе переводы на русский), но в этом случае далеко не все применимо для документации на русском. Мне в свое время помогла литература тематики "научно-технический перевод" (но поскольку назначение другое (перевод), то потребуется самостоятльный анализ, переосмысление).


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

Виктор Фигурнов
30 октября 2015, 10:15

К предыдущему списку я бы добавил ещё:

Krista Van Laan. The Insider's Guide to Technical Writing 

http://www.amazon.com/The-Insiders-Guide-Technical-Writing/dp/1937434036

Krista Van Laan. The Complete Idiot's Guide to Technical Writing

http://www.amazon.com/Complete-Idiots-Guide-Technical-Writing/dp/0028641469

How to Land an Entry Level Technical Writing Job

http://www.wikihow.com/Land-an-Entry-Level-Technical-Writing-Job

И книги русских авторов:

Глаголев В.А. Разработка технической документации (Питер, 2008)

Липаев В.В. Документирование сложных программных средств (Синтег, 2005)