Заказать звонок

Технический писатель, направления для развития

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
   RSS
Технический писатель, направления для развития, Обсуждаем какие профессиональные направления развития есть у технического писателя
 
Тут задался вопросом, в каких направлениях развиваться? Вижу, от тех. писателя требуется либо знание ГОСТ, либо технический английский, редко сразу оба. Часто поощряется Linux, DocBook, LaTeX, DITA. Как вы видите для себя развитие в области?
Страницы: Пред. 1 2 3 4 5 След.
Ответы
 
Цитата
Марина пишет:
актически 2 в 1, тех. писатель + аналитик. Но там, где должности разделены, мне кажется, всё равно все документы должны проходить через тех. писателя. Общая грамотность текстов, единство стиля, оформление - это все его работа.
Нет, к аналитикам требования к русскому языку, грамотности и умению излагать мысли должны быть не меньше, чем к писателям . Единство стиля, оформление также у аналитиков свое и может отличаться от писателей.

Это не его работа. Вы еще должностные инструкции, приказы, договоры и контракты туда влепите, чтобы после отдела кадоров/юристов писатель проверял запятые   :D  

Цитата
Марина пишет:
Не поняла вопрос. Сайта, ТЗ к которому писалось по 34 госту?
Нет, ТЗ, выполненному в виде сайта  :)     Когнитивный диссонанс?  
ТЗ не обязательно в ворде писать, можно в вики-системах, в системах управления задачами и проектами. В блокноте на худой конец.  
Изменено: ADVANCED - 07.10.2014 10:07:32
 
Цитата
ADVANCED пишет:
Я подобным занимался лет 8 назад и назывался "специалист по подготовке учебных материалов и презентаций". Не нужно было вдаваться в подробности программной логики и функционала, описывались только юзкейсы, при этом нахваливая программу.
Неправда :))) Организация обучения довольно часто возлагается на плечи техписов. И это правильно.
Цитата
ADVANCED пишет:
Есть пример красочного сайта технического задания по ГОСТ34?
У меня есть :))))
techwriter.ru.com
 
ТЗ могут писать аналитик, менеджер проекта, частично заказчик. Документы технического и рабочего проектов - программисты, системный архитектор. У них с грамотностью хуже, чем у аналитиков."Корова" через а не пишут, но забывают запятые, неправильно согласовывают деепричастные обороты. Пишут сложно и запутанно, так что сами не всегда потом понимают, что имели ввиду. Программу и методику испытаний вместе с аналитиком может писать тестер. Руководство пользователя - технический писатель. Кто-то должен привести все эти документы по одному проекту к единому виду - как минимум, чтобы терминология была сквозной. Кто этим должен заниматься?

http://techwriters.ru/forum/forum607/topic18101/ - тема с нашего форума про обязанности техписателя. Во всех примерах должностных инструкций присутствует "техническое редактирование научно-технических, информационных и нормативных материалов предприятия на русском и английском языках".
 
Цитата
Марина пишет:
Кто-то должен привести все эти документы по одному проекту к единому виду - как минимум, чтобы терминология была сквозной. Кто этим должен заниматься?
Каждый, кто этим занимается в повседневной деятельности, но не один человек и не тех.писатель. Он конечно же может, на него могут спихнуть такую работу, но за это он не получает ни зарплату, ни несет ответственности.
В идеале, должна быть определена терминология, стили и шаблоны, которых должны придерживаться все роли: аналитики, тестировщики, разработчики, писатели, техподдержка и т.п.

Если создается новая терминология, то она сначала обговаривается между заказчиком и аналитиком, чтобы стороны понимали друг друга. Писатель - последнее звено в цепочке и он может не подозревать, что ведется разработка того или иного ПО, а может быть подключен к документированию на этапе тестирования или после. Тем более, ТЗ, по которому велась разработка, он увидит по факту.
Цитата
Марина пишет:
http://techwriters.ru/forum/forum607/topic18101/ - тема с нашего форума про обязанности техписателя. Во всех примерах должностных инструкций присутствует "техническое редактирование научно-технических, информационных и нормативных материалов предприятия на русском и английском языках".
Форум - не показатель и информация на нем всего лишь чья-то точка зрения, видение и рассуждение.
Цитата
techwriter пишет:
Организация обучения довольно часто возлагается на плечи техписов. И это правильно.
Писатель может и полы помыть и кондиционер заправить, но это не профессиональная деятельность. Возможно кому-то оплачивают подготовку материалов для обучения, но это оговаривается отдельно, учитывая навыки сотрудника. Я занимался этим в основной должности, до работы тех.писом.
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.


Цитата
techwriter пишет:
У меня есть :  ))))  
Продемонстрируй, пожалуйста  :)
Изменено: ADVANCED - 07.10.2014 11:57:57
 
Цитата
ADVANCED пишет:
Писатель может и полы помыть и кондиционер заправить, но это не профессиональная деятельность. Возможно кому-то оплачивают подготовку материалов для обучения, но это оговаривается отдельно, учитывая навыки сотрудника. Я занимался этим в основной должности, до работы тех.писом.
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.
А разработкой e-learning кто должен заниматься?
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Продемонстрируй, пожалуйста
Что именно? Сайт или ТЗ?
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.
Причем здесь вообще Power Point? Power Point такой же каменный век в разработке обучающих материалов, как MS Word в современном авторинге ;)
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Писатель может и полы помыть и кондиционер заправить, но это не профессиональная деятельность. Возможно кому-то оплачивают подготовку материалов для обучения, но это оговаривается отдельно, учитывая навыки сотрудника. Я занимался этим в основной должности, до работы тех.писом.
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.
А разработкой e-learning кто должен заниматься?

Педагогический дизайнер.  

Вырезка о навыках:
  • Нужна теория: теория обучения, когнитивные теории, психология обучения и восприятия информации. И чем ее будет больше, тем ярче будет картинка того, что вы делаете. В какой-то момент станет понятно, почему что-то можно делать, а что-то нет, и для этого будет логичное и понятное объяснение.
  • Нужно знать инструмент, с помощью которого будет создаваться курс. Интересно, но в классическом учебнике по педагогическому дизайну есть целая глава про аналих медиа средств для доставки знаний. И в целом, его вроде бы все делают: выясняют, какой доступен интернет, есть ли звук, какой ПК. А вот проверить основной инструмент разработки - забываем.
  • Нужно читать про дизайн и смотреть примеры. И знать, что хорошо, а что плохо в оформлении курса. Электронный курс воспринимается визуально, и если внешне он кривой, то и восприятие его содержания будет не самым позитивным. И даже если у вас дизайнер, который будет рисовать графику, вы все равно должны представлять, что именно вы хотите получить в итоге.
  • Нужно много читать: про людей, про технологии, про развитие личности. Именно в таких книгах часто есть исследования и наработки, которые педагогическому дизайнеру помогают увидеть свою аудиторию и сделать для нее максимально эффективный курс.
Изменено: ADVANCED - 07.10.2014 13:06:58
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Продемонстрируй, пожалуйста
Что именно? Сайт или ТЗ?
ТЗ, выполненное в виде сайта. Второй раз уже повторил  :)
Изменено: ADVANCED - 07.10.2014 13:50:41
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.
Причем здесь вообще Power Point? Power Point такой же каменный век в разработке обучающих материалов, как MS Word в современном авторинге  ;)
Power Point здесь  упомянул, чтобы отличить от Word.  ;)
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
А разработкой e-learning кто должен заниматься?

Педагогический дизайнер
Это в идеале, не все компании еще готовы технического писателя взять на должность, вот и вешают на него все. Тут или нужно соглашаться или не идти на такую работу. Лично мне нравится дист.курсы делать, поэтому я не прочь иногда отдохнуть от документации.
 
Цитата
writer пишет:
Это в идеале, не все компании еще готовы технического писателя взять на должность, вот и вешают на него все. Тут или нужно соглашаться или не идти на такую работу. Лично мне нравится дист.курсы делать, поэтому я не прочь иногда отдохнуть от документации.
Да, писатели делают учебные курсы, не спорю. Я будучи писателем не только делал, но и проводил обучение, и мне за это небольшую премию платили отдельно. Так как на тот момент не было возможности нанимать кого-то, а я больше всех по навыкам подходил на эту работу.
Вопрос не в том, что нравится или не нравится. Должен и нравится - разные вещи.
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Продемонстрируй, пожалуйста
Что именно? Сайт или ТЗ?
ТЗ, выполненное в виде сайта. Второй раз уже повторил  :)
Повтори третий, потому что непонятно, что имеется в виду.
ТЗ на сайт пишется на основании прототипов. Разработчики могут посмотреть сам прототип, заказчики тоже. Но, как правило, заказчикам нужна наглядность в виде документа. Какая разница, по какому ГОСТу или не по ГОСту пишется ТЗ? Оно в любом случае будет отражать одно и то же.
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Писатель может и полы помыть и кондиционер заправить, но это не профессиональная деятельность. Возможно кому-то оплачивают подготовку материалов для обучения, но это оговаривается отдельно, учитывая навыки сотрудника. Я занимался этим в основной должности, до работы тех.писом.
Если тех.пис не слышал о PowerPoint или не знает как донести информацию до человека, который возможно станет пользователем, его нельзя критиковать за это. Это навык, а не обязанность.
А разработкой e-learning кто должен заниматься?

Педагогический дизайнер .

Вырезка о навыках:
Нужна теория: теория обучения, когнитивные теории, психология обучения и восприятия информации. И чем ее будет больше, тем ярче будет картинка того, что вы делаете. В какой-то момент станет понятно, почему что-то можно делать, а что-то нет, и для этого будет логичное и понятное объяснение. Нужно знать инструмент, с помощью которого будет создаваться курс. Интересно, но в классическом учебнике по педагогическому дизайну есть целая глава про аналих медиа средств для доставки знаний. И в целом, его вроде бы все делают: выясняют, какой доступен интернет, есть ли звук, какой ПК. А вот проверить основной инструмент разработки - забываем. Нужно читать про дизайн и смотреть примеры. И знать, что хорошо, а что плохо в оформлении курса. Электронный курс воспринимается визуально, и если внешне он кривой, то и восприятие его содержания будет не самым позитивным. И даже если у вас дизайнер, который будет рисовать графику, вы все равно должны представлять, что именно вы хотите получить в итоге. Нужно много читать: про людей, про технологии, про развитие личности. Именно в таких книгах часто есть исследования и наработки, которые педагогическому дизайнеру помогают увидеть свою аудиторию и сделать для нее максимально эффективный курс.
Какая разница, как это называется "технический писатель" или "педагогический дизайнер"? Люди будут работать в одном отделе, но с разной направленностью работ. А инструменты технического писателя и педагогического дизайнера вообще одни?
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Вопрос не в том, что нравится или не нравится. Должен и нравится - разные вещи.
Конкретно у вас кто занимается дизайном разрабатываемых справок?
techwriter.ru.com
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Продемонстрируй, пожалуйста
Что именно? Сайт или ТЗ?
ТЗ, выполненное в виде сайта. Второй раз уже повторил  :)  
Повтори третий, потому что непонятно, что имеется в виду.
ТЗ на сайт пишется на основании прототипов. Разработчики могут посмотреть сам прототип, заказчики тоже. Но, как правило, заказчикам нужна наглядность в виде документа. Какая разница, по какому ГОСТу или не по ГОСту пишется ТЗ? Оно в любом случае будет отражать одно и то же.
Повторяю сначала:
Цитата
Марина пишет:
Техническое задание отлично пишется по 34 госту, если использовать его в ситуации, для которой он и был предназначен - создание автоматизированной системы "под ключ", включая установку и настройку ПО на технике заказчика, возможно, поставку или апгрейд техники, обучение персонала.
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Есть пример красочного сайта технического задания по ГОСТ34?
У меня есть :  ))))  
Пример ТЕХНИЧЕСКОГО ЗАДАНИЯ в виде сайта.

Цитата
techwriter пишет:
ТЗ на сайт пишется на основании
Не ТЗ на сайт, а сайт, с структурированным изложением требований на разработку автоматизированной системы.
Не в DOC, не в RTF, не в PDF, а на HTML-страницах. Т.е. набор HTML-страниц, оформленных по ГОСТ34, имеющих разделы, отступы, шрифты и т.п.
Изменено: ADVANCED - 07.10.2014 13:52:45
 
Цитата
ADVANCED пишет:
Не ТЗ на сайт, а сайт, с структурированным изложением требований на разработку автоматизированной системы.
Не в DOC, не в RTF, не в PDF, а на HTML-страницах. Т.е. набор HTML-страниц, оформленных по ГОСТ34, имеющих разделы, отступы, шрифты и т.п.
Прототип сайта и есть набор HTML-страниц. Требования к конкретным полям, действиям, кнопкам описывается в ТЗ. По какому ГОСТу ты будешь писать это ТЗ, абсолютно без разницы.
techwriter.ru.com
 
Вы зациклились на Ворде.
ТЗ необязательно писать в ворде, оно не обязательно должно быть распечатано на принтере. Оно не обязательно должно быть по ГОСТ и тд.
При упоминании ТЗ, почему-то ассоциация о печатном документе. Оно может быть в HTML и им пользуются разработчики как им удобно. Один на планшете, другой на компе, третьему достаточно прочитать.

Книги тоже не обязательно должны быть на бумаге. Есть e-book со своими форматами. И в них тоже можно писать и ТЗ и другую документацию и ГОСТ можно забыть.  
Изменено: ADVANCED - 07.10.2014 14:00:08
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Не ТЗ на сайт, а сайт, с структурированным изложением требований на разработку автоматизированной системы.
Не в DOC, не в RTF, не в PDF, а на HTML-страницах. Т.е. набор HTML-страниц, оформленных по ГОСТ34, имеющих разделы, отступы, шрифты и т.п.
Прототип сайта и есть набор HTML-страниц. Требования к конкретным полям, действиям, кнопкам описывается в ТЗ. По какому ГОСТу ты будешь писать это ТЗ, абсолютно без разницы.
Прототип сайта тут ни при чем   8)   А прототип калькулятора - это что? А двигателя внутреннего сгорания?
Ладно проехали   :D
Изменено: ADVANCED - 07.10.2014 14:03:03
 
Цитата
ADVANCED пишет:
Вы зациклились на Ворде.
ТЗ необязательно писать в ворде, оно не обязательно должно быть распечатано на принтере. Оно не обязательно должно быть по ГОСТ и тд.
При упоминании ТЗ, почему-то ассоциация о печатном документе. Оно может быть в HTML и им пользуются разработчики как им удобно. Один на планшете, другой на компе, третьему достаточно прочитать.

Книги тоже не обязательно должны быть на бумаге. Есть e-book со своими форматами. И в них тоже можно писать и ТЗ и другую документацию и ГОСТ можно забыть.
Предложи свой вариант ТЗ так, чтобы при этом печатного и электронного документа не существовало в природе. При этом ТЗ содержало все обоснования решений, ограничения и условия.
techwriter.ru.com
 
Цитата
ADVANCED пишет:
При упоминании ТЗ, почему-то ассоциация о печатном документе. Оно может быть в HTML и им пользуются разработчики как им удобно. Один на планшете, другой на компе, третьему достаточно прочитать.
Конкретно у тебя такая ассоциация, а не у всех. "Печатный документ" - это документ, который может быть распечатан, и не более того.
techwriter.ru.com
 
Цитата
ADVANCED пишет:
Прототип сайта тут ни при чем  8)  А прототип калькулятора - это что? А двигателя внутреннего сгорания?
Ладно проехали
Прототип - это модель. При проектировании чего угодно, в первую очередь, создается модель причем разными методами и средствами. Описания к модели не должно существовать в природе?
techwriter.ru.com
 
Цитата
ADVANCED пишет:
ТЗ ... не обязательно должно быть распечатано на принтере.


Полный бред!
ТЗ - официальный юридический (в случае конфликта между Заказчиком и Исполнителем) документ, который должен быть утвержден подписями и гербовой печатью Заказчика и согласующими  (утверждающими) подписями и печатью Исполнителя..
 
Цитата
Гость пишет:
ТЗ - официальный юридический (в случае конфликта между Заказчиком и Исполнителем) документ, который должен быть утвержден подписями и гербовой печатью Заказчика и согласующими (утверждающими) подписями и печатью Исполнителя..
Это не так.
1. ТЗ составляется и на разработки, которые делаются фирмой-разработчиком по собственной инициативе.
2. Подписание ТЗ заказчиком и исполнителем это советская бюрократическая практика, совершенно не принятая в других странах. Там обычно подписываются договора и акты, а ТЗ это один из прилагаемых к ним документов.
3. Во многих западных фирмах нет печатей, тем более гербовых. Да и в России печати скоро сделают необязательными.
 
Полностью согласен с Виктором, ТЗ может быть как внешним так и внутренним документом, где Заказчиком может выступать коммерческий отдел.
Страницы: Пред. 1 2 3 4 5 След.
Читают тему

Рейтинг@Mail.ru