Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1 2 3 4 5 6 7 8 9 10 11 ... 18 След.
Согласование оперативных доработок, Согласование оперативных доработок
 
Я бы составила дополнение к договору.
Яндекс организует конференцию для разработчиков документации 18 апреля
 
Цитата
Марина написал:
"Продукт сложный, для настройки и поддержки необходимо  привлекать сторонних специалистов. Мы несколько месяцев занимаемся внедрением, про результаты говорить пока рано. Но техписателям нужно убеждать начальство перейти на него, потому что опыт работы  с DITA - полезная строка в резюме техписателя."

DITA - продукт? Прикольно :)))
techwriter.ru.com
Поздравляем с Днем рождения!, Поздравления с Днем рождения!
 
 С Днём Рождения! :)
Изменено: techwriter - 31.03.2015 14:44:05
techwriter.ru.com
Самых прекрасных, красивых и восхитительных! С праздником!
 
Спасибо! :)
techwriter.ru.com
Юмор!
 
 
techwriter.ru.com
Фон основного текста
 
Здравствуйте.
В CSS можно задать.
Как устроиться на работу
 
Я в своём блоге писала:
[URL=http://techwriter.ru.com/category/%d0%ba%d0%b0%d0%ba-%d1%81%d1%82%d0%b0%d1%82%d1%8c-%d1%82%d0%b5%d1%85%d0%bd%d0%b8%d1%87%d0%b5%d1%81%d0%ba%d0%b8%d0%bc-%d0%bf%d0%b8%d1%81%d0%b0%d1%82%d0%b5%d0%bb%d0%b5%d0%bc/]http://techwriter.ru.com/category/%d0%ba%d0%b0%d0%ba-%d1%81%d1%82%d0%b0%d1%82%d1%8c-%d1%82%d0%b5%d1%...[/URL]
Думаю, что надо начать с того, чтобы определиться, насколько Вам вообще подходит работа технического писателя :)
Юмор!
 
 
techwriter.ru.com
Расценки на удаленное писательство, Сколько просить?
 
[QUOTE]убожетымой написал:
[URL=http://techwriters.ru/forum/user/14578/]techwriter[/URL] спасибо!
А в эту сумму входит текст с картинками или "чистый" текст?[/QUOTE]

От заказчика зависит :D
Вообще нужно исходить из каждого конкретного заказчика. Если работа срочная и с высоким приоритетом, то планка может быть высокой. Если задача несрочная и невысоким приоритетом, то можно падать в цене.
А так, можно просто составить прайс-лист на услуги и предъявить.
Расценки на удаленное писательство, Сколько просить?
 
500-600 руб./лист - это мой прайс для компаний.
Обратное проектирование
 
[QUOTE]TatLeo написал:
Добрый день! Один из разделов документа "Описание системы" это Описание логической структуры. В данный раздел добавлена диаграмма классов системы (правильно или нет?). К схеме необходимо добавить текстовое описание (правильно или нет?). Какой стиль изложения использовать? Что нужно отобразить в данном описании? Заранее спасибо![/QUOTE]

[I]6. В разделе «Описание логической структуры» должны быть указаны:[/I]
[I]алгоритм программы;[/I]
[I]используемые методы;[/I]
[I]структура программы с описанием функций составных частей и связи между ними;[/I]
[I]связи программы с другими программами.[/I]
[I][B]Описание логической структуры программы выполняют с учетом текста программы на исходном языке.[/B][/I]
[B][/B]
Диаграммы классов недостаточно. Как минимум, необходимо сделать ещё диаграмму последовательности.
С учётом ссылки в ГОСТ на то, что описание должно быть выполнено с учётом текста программы, я бы ещё сделала описание физической структуры. На мой взгляд, описания физической структуры недостаточно.
Обратное проектирование
 
[QUOTE]ADVANCED пишет:
Изучать языки программирования в теории только для того, чтобы в будущем писать какую-то документацию -тупиковый путь. Должна быть цель.
[/QUOTE]Зачем в теории? Изучай на практике.
Обратное проектирование
 
[QUOTE]ADVANCED пишет:
У него появляется стимул начать разбираться. Самая большая проблема - "НАЧАТЬ", а далее человек втягивается, ему становится интересно и разбирается понемногу. Если не интересно, то профессия не его.

Техническому писателю приходится разбираться в архитектуре, в коде, в алгоритмах, в концепциях того или иного продукта. Такова работа. Поверь, далее это пригодится.

Автор темы уже заинтересован и вопрос был "с чего начать".
[/QUOTE]Угу. Ты мне так рассказываешь, как будто я документации для программистов не писала... Поэтому на "поверь" могу ответить своё "поверь", что на выходе качественного документа не выйдет, если технический писатель не в теме. Вряд ли он сможет на начальном этапе даже грамотно вопросы программисту задать. Поэтому обучаться программированию надо было в свободное время на тренингах до получения подобных задач. Моё мнение - сначала надо дорасти до определённого уровня, а потом уже браться за подобные задачи.
Если документация не имеет практического применения, то можно, конечно, писать как хочешь и что хочешь. Но абсолютно уверена, что бест практис для программистов может написать только гуру-программист.
Обратное проектирование
 
[QUOTE]ADVANCED пишет:

А техпис чем тогда должен заниматься? Техпис должен разбираться и описывать.
Из букв составлять слова, если знает алфавит?

[/QUOTE]
Технический писатель не специалист?
Разбираться в чём? В коде, написанном кем-то?
Чтобы в нём разобраться, требуется много трудозатрат с учётом того, что технический писатель его ни разу в данном случае в глаза не видел. Поэтому с менеджерской точки зрения задача поставлена убого, без вникания в риски, к которым это приведёт. Написать абы чё может каждый. Написать хорошую подробную документацию - только тот, кто детально разбирается в предмете того, что описывает.
Если технический писатель не знает даже основ ООП, то что он выдаст на выходе?
Изменено: techwriter - 27.01.2015 10:01:39
Обратное проектирование
 
[QUOTE]TatLeo пишет:
Да. Задача уже поставлена. Получается, что консультироваться с разработчиками придется постоянно. Модулей куча! Сейчас параллельно в работе три процесса: изучение основ ООП, Java и исходников. И беспокоит то, сколько разработчик будет отвечать на вопросы? Ведь чем глубже погружаешься в задачу, тем больше вопросов возникает. Возможно некоторые вопросы неоднократно.
[/QUOTE]Если в проекте есть менеджер, то до него имеет смысл довести, что для решения задачи требуется постоянная консультация разработчиков. Это поможет избежать затягивание предоставления ответов.
Обратное проектирование
 
Добрый день!
Если честно, задача странная. Ею должен заниматься специалист, который знает Java либо хотя бы имеет о ней представление.
Но если она так поставлена, то надо сначала изучить основы ООП и Java, затем проконсультироваться с разработчиками (им виднее, что они там накодили) и потом уже приступать.
Из процессного менеджера в технические писатели, Как составить портфолио?
 
Добрый день!
Думаю, нельзя, раз подписано соглашение о конфиденциальности. Я выкладываю в портфолио только документы, которые не носят конфиденциального характера:
[url]http://techwriter.ru.com/portfolio/[/url]
[COLOR=#000000]Если у вас таких примеров нет, то имеет смысл сделать примеры на открытых онлайн-сервисах.[/COLOR]
Программа и методика: как оформлять
 
Здравствуйте, Ася!  :)
Ответ на Ваш вопрос зависит от многих условий.
Думаю, надо разобраться в терминологии. ЧТЗ - это дополнительный документ к ТЗ, который разрабатывается на части АС (см. ГОСТ 34). Структура ЧТЗ идентична структуре ТЗ. Допускается не включать в ЧТЗ разделы, уже имеющиеся в ТЗ.
В общем случае, в ПМИ должны быть приведены проверки выполнения [B]всех[/B] требований, указанных в разделе "Требования к системе" (ТЗ, ЧТЗ). На мой взгляд, правильно в этом случае скомпоновать требования ТЗ и ЧТЗ, и на их основании написать ПМИ. Т.е., если требования к функциям описаны в ЧТЗ детальнее, то их проверку и описывать в ПМИ.
По второму вопросу могу лишь предположить, что проверяющий опирается на стандарт:
[url]http://www.gosthelp.ru/text/GOST2819589Ocenkakachestv.html[/url]
Либо на похожий стандарт.
Я бы на вашем месте, уточнила у проверяющего, какой стандарт он применяет для обозначения показетелей.
Веб-мессенджер или чат для технических писателей, Веб-мессенджер или чат для технических писателей
 
[QUOTE]TatLeo пишет:

Как зайти в веб-мессенджер? По ссылке в правом верхнем углу форума открывается данная ветка.
[/QUOTE]
См. скриншот:
Изменено: techwriter - 20.01.2015 15:20:27
Акция: Поделись шаблонами!
 
[QUOTE]TatLeo пишет:

Тема актуальна? Есть ссылка на раздел?
[/QUOTE]


Шаблоны есть тут:
[url]http://techwriters.ru/services-for-technical-writers/shablony-technicheskoy-dokumentacii/[/url]

Может, ещё вам этот раздел поможет  :)  
[url]http://techwriters.ru/services-for-technical-writers/gosts-and-standards/gost/[/url]
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
TatLeo пишет:

Добрый день! Подскажите, пожалуйста, где можно посмотреть или взять пример/шаблон такого документа, как "Описание программы".


Добрый день!
Документ "Описание программы" разрабатывается в соответствии с требованиями ГОСТ 19.402-78.
Какие именно разделы вам непонятны?
techwriter.ru.com
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
Гость пишет:

Добрый день!
Форум живой?
Живой :)
techwriter.ru.com
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
ADVANCED пишет:

Вопрос появился, не могу найти обоснованный ответ.  Поможет кто?
 Калькулятор   *   тарифно  **   план  *

Калькулятор для выбора тарифного плана
Калькулятор по выбору тарифного плана
Калькулятор выбора тарифного плана
Калькулятор выбора из тарифных планов

Как правильно и почему?

Калькулятор тарифного плана?
techwriter.ru.com
С Новым 2015 годом!
 
Цитата
writer пишет:
А я в отпуск, меня не теряйте !!!
Приятного отдыха!  beach-smile
techwriter.ru.com
С Новым 2015 годом!
 
Всех с прошедшими! :)
techwriter.ru.com
Страницы: 1 2 3 4 5 6 7 8 9 10 11 ... 18 След.