В данный момент у нас нет отдела технической документации... Есть команда, состоящая из 6 человек: 4 разработчика, 1 тестировщик и 1 технический писатель. Задачи назначаются не отдельного человека, а на команду. В основе - принцип самоорганизации команды. Основной акцент не на достижении членом команды какого-то своего результата, а именно вклад в решение задач команды.
techwriter (Все сообщения пользователя)
Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru!
@twriters чат для технических писателей в Telegram
Отдел технической документации, Обсуждаем тему организации отдела технической документации, структуру, задачи, работу отдела
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
Как техническому писателю получать консультации от разработчиков? Инструкция к применению, Учимся мягко и настойчиво выбивать всею информацию от программистов!
24.07.2014 09:13:45
[QUOTE]writer пишет:
Поделимся опытом в добывания информации от разработчиков. Как вы узнаете про новый функционал, каким образом записываете информацию (диктофон, текстовые заметки, примечания/правки в документации...). [/QUOTE]Сейчас я работаю по Agile. Мне он нравится тем, что я равный член команды и участвую в процессе обсуждения доработок, планировании работ, их оценке. Каждый день у нас stand up, на котором я могу озвучить свои результаты, и главное, вопросы и трудности, которые у меня возникают. Поскольку задачи ставятся на команду, а не на конкретного участника, то в достижении цели заинтересованы все, из-за чего автоматически устанавливаются отношения взаимопомощи. Считаю, что пока что это самая удачная практика в моей карьере технического писателя, а работаю я им почти 9 лет :))) |
|
|
Как техническому писателю получать консультации от разработчиков? Инструкция к применению, Учимся мягко и настойчиво выбивать всею информацию от программистов!
Прошу оценить тестовое задание для технического писателя, Выполнил тестовое задание при приеме на работу, прошу оценить специалистов
23.07.2014 13:32:18
[QUOTE]fs444 пишет:
Всем привет. Только начинаю путь технического писателя. В одной из фирм предложили выполнить тестовое задание - написать "Руководство оператора" к любой программе записи CD. При этом использовать "ГОСТ 19.505-79 Руководство оператора". Пока мне никто не перезвонил)) Кому не сложно, прошу оценить уровень выполненной мною работы. [url]https://yadi.sk/i/tk2xm_IRXAoCp[/url] [/QUOTE]По содержанию для новичка неплохо, но вот оформление хромает. Попробуйте поизучать стили. Еще неплохо было бы пронумеровать и подписать рисунки, а также инструкции сделать в виде нумерованных списков. Если доведете до ума, сможете отправлять пример как приложение к резюме ;) |
|
|
Актуализация документации: как правильно??
23.07.2014 12:13:35
[QUOTE]Виктор Фигурнов пишет:
ISO/IEC/IEEE 26515:2011 Systems and software engineering -- Developing user documentation in an agile environment [/QUOTE] Стандарт подходит тем, кто по Agile работают.
Изменено: techwriter - 23.07.2014 12:13:55
|
|
|
Актуализация документации: как правильно??
Что происходит на рынке разработки технической документации, Ситуация с удаленной работой для технического писателя, рынок разработки технической документации
22.07.2014 14:59:45
![]() ![]()
techwriter.ru.com
|
|||
|
Критерий, параметр или условие?, Какие термины вы выбираете при написании технической документации
Как вы называете привязку одной сущности к другой
22.07.2014 09:21:15
[QUOTE]writer пишет:
никакой, но без него никак)) просто система понимает что груз поступил и его повезли куда-то) [/QUOTE]Придумала только один вариант: распределение груза по машинам :) ) Мне кажется такой вариант понятнее "привязки" или "связки".
Изменено: techwriter - 22.07.2014 09:22:14
|
|
|
Что происходит на рынке разработки технической документации, Ситуация с удаленной работой для технического писателя, рынок разработки технической документации
Куда поедем в отпуск?
Как вы называете привязку одной сущности к другой
Рабочие окна, Называем правильно открытые окна программы
Критерий, параметр или условие?, Какие термины вы выбираете при написании технической документации
Радиокнопка или переключатель
Критерий, параметр или условие?, Какие термины вы выбираете при написании технической документации
Разработка типовых сценариев работы с системой, Обсуждаем разработку типовых сценариев работы с системой
15.07.2014 12:14:51
[QUOTE]writer пишет:
Не всегда, сценарии это на мой взгляд более жизненные примеры и , действительно, более наглядные. [/QUOTE]Я сейчас как раз описываю примеры настройки интерфейса (списков, форм). Но я там пишу по такому принципу: если ввести такое-то значение, то будет так-то. И прилагаю скриншот с результатом. |
|
|
Как вы называете привязку одной сущности к другой
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
Опоздания на работу, Опоздания на работу
Разработка типовых сценариев работы с системой, Обсуждаем разработку типовых сценариев работы с системой
02.07.2014 16:29:52
[QUOTE]Виктор Фигурнов пишет:
Более подробно смотрите здесь: [url]http://deseng.ryerson.ca/dokuwiki/design:usage_scenario[/url] [url]http://www.redline-software.com/eng/products/surfcop/scenarios/[/url] [/QUOTE]Такие сценарии, скорее, при проектировании пишутся. |
|
|
Разработка типовых сценариев работы с системой, Обсуждаем разработку типовых сценариев работы с системой
02.07.2014 16:26:57
[QUOTE]writer пишет:
ну к примеру, есть банковское ПО, руководство пользователя описывает всю инструкцию для пользователя, что нужно и не нужно, а типовой сценарий работы, это что-то типа "Как положить денежку на карту", "Как снять денежку", "Как посмотреть баланс на карте" вот такие сценарии. [/QUOTE]В руководстве пользователя разве эти действия не описываются? Изложение руководства пользователя может идти от интерфейса и от действий пользователя. Я обычно исхожу как раз от действий пользователя. Если изложение от действий, то в нем оно строится таким образом: цель, которую нужно достичь пользователю - действия, которые необходимо выполнить. Если достичь цель можно несколькими способами, то описываются все случаи. Я так понимаю, что сценарии просто кратко описывают процедуру выполнения действий пользователя для достижения целей (без подробного описания полей формы, например). Допустим, "Зайдите в такой-то раздел, нажмите такую-то кнопку, заполните такую-то форму и т.д., и т.п. Мне даже больше тест-кейсы напоминает, чем юз-кейсы. Только более мультимедийные. |
|
|
Предметная область и тех. писатель, Можно ли знать все?
Предметная область и тех. писатель, Можно ли знать все?