Я бы составила дополнение к договору.
techwriter (Все сообщения пользователя)
Внимание! Если не пришло письмо о регистрации напишите нам на почту!
@twriters 
чат для технических писателей в Telegram
Согласование оперативных доработок, Согласование оперативных доработок
Яндекс организует конференцию для разработчиков документации 18 апреля
|
techwriter
 Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
24.04.2015 15:19:50
DITA - продукт? Прикольно  ))
techwriter.ru.com
|
||
|
|
|
Поздравляем с Днем рождения!, Поздравления с Днем рождения!
Самых прекрасных, красивых и восхитительных! С праздником!
Юмор!
Фон основного текста
Как устроиться на работу
Юмор!
Расценки на удаленное писательство, Сколько просить?
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
18.02.2015 09:10:48
[QUOTE]убожетымой написал:
[URL=http://techwriters.ru/forum/user/14578/]techwriter[/URL] спасибо! А в эту сумму входит текст с картинками или "чистый" текст?[/QUOTE] От заказчика зависит :D Вообще нужно исходить из каждого конкретного заказчика. Если работа срочная и с высоким приоритетом, то планка может быть высокой. Если задача несрочная и невысоким приоритетом, то можно падать в цене. А так, можно просто составить прайс-лист на услуги и предъявить. |
|
|
|
Расценки на удаленное писательство, Сколько просить?
Обратное проектирование
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
03.02.2015 06:29:32
[QUOTE]TatLeo написал:
Добрый день! Один из разделов документа "Описание системы" это Описание логической структуры. В данный раздел добавлена диаграмма классов системы (правильно или нет?). К схеме необходимо добавить текстовое описание (правильно или нет?). Какой стиль изложения использовать? Что нужно отобразить в данном описании? Заранее спасибо![/QUOTE] [I]6. В разделе «Описание логической структуры» должны быть указаны:[/I] [I]алгоритм программы;[/I] [I]используемые методы;[/I] [I]структура программы с описанием функций составных частей и связи между ними;[/I] [I]связи программы с другими программами.[/I] [I][B]Описание логической структуры программы выполняют с учетом текста программы на исходном языке.[/B][/I] [B][/B] Диаграммы классов недостаточно. Как минимум, необходимо сделать ещё диаграмму последовательности. С учётом ссылки в ГОСТ на то, что описание должно быть выполнено с учётом текста программы, я бы ещё сделала описание физической структуры. На мой взгляд, описания физической структуры недостаточно. |
|
|
|
Обратное проектирование
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
29.01.2015 12:35:33
[QUOTE]ADVANCED пишет:
Изучать языки программирования в теории только для того, чтобы в будущем писать какую-то документацию -тупиковый путь. Должна быть цель. [/QUOTE]Зачем в теории? Изучай на практике. |
|
|
|
Обратное проектирование
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
29.01.2015 11:19:38
[QUOTE]ADVANCED пишет:
У него появляется стимул начать разбираться. Самая большая проблема - "НАЧАТЬ", а далее человек втягивается, ему становится интересно и разбирается понемногу. Если не интересно, то профессия не его. Техническому писателю приходится разбираться в архитектуре, в коде, в алгоритмах, в концепциях того или иного продукта. Такова работа. Поверь, далее это пригодится. Автор темы уже заинтересован и вопрос был "с чего начать". [/QUOTE]Угу. Ты мне так рассказываешь, как будто я документации для программистов не писала... Поэтому на "поверь" могу ответить своё "поверь", что на выходе качественного документа не выйдет, если технический писатель не в теме. Вряд ли он сможет на начальном этапе даже грамотно вопросы программисту задать. Поэтому обучаться программированию надо было в свободное время на тренингах до получения подобных задач. Моё мнение - сначала надо дорасти до определённого уровня, а потом уже браться за подобные задачи. Если документация не имеет практического применения, то можно, конечно, писать как хочешь и что хочешь. Но абсолютно уверена, что бест практис для программистов может написать только гуру-программист. |
|
|
|
Обратное проектирование
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
27.01.2015 10:00:47
[QUOTE]ADVANCED пишет:
А техпис чем тогда должен заниматься? Техпис должен разбираться и описывать. Из букв составлять слова, если знает алфавит? [/QUOTE] Технический писатель не специалист? Разбираться в чём? В коде, написанном кем-то? Чтобы в нём разобраться, требуется много трудозатрат с учётом того, что технический писатель его ни разу в данном случае в глаза не видел. Поэтому с менеджерской точки зрения задача поставлена убого, без вникания в риски, к которым это приведёт. Написать абы чё может каждый. Написать хорошую подробную документацию - только тот, кто детально разбирается в предмете того, что описывает. Если технический писатель не знает даже основ ООП, то что он выдаст на выходе?
Изменено: techwriter - 27.01.2015 10:01:39
|
|
|
|
Обратное проектирование
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
26.01.2015 11:56:17
[QUOTE]TatLeo пишет:
Да. Задача уже поставлена. Получается, что консультироваться с разработчиками придется постоянно. Модулей куча! Сейчас параллельно в работе три процесса: изучение основ ООП, Java и исходников. И беспокоит то, сколько разработчик будет отвечать на вопросы? Ведь чем глубже погружаешься в задачу, тем больше вопросов возникает. Возможно некоторые вопросы неоднократно. [/QUOTE]Если в проекте есть менеджер, то до него имеет смысл довести, что для решения задачи требуется постоянная консультация разработчиков. Это поможет избежать затягивание предоставления ответов. |
|
|
|
Обратное проектирование
Из процессного менеджера в технические писатели, Как составить портфолио?
Программа и методика: как оформлять
Веб-мессенджер или чат для технических писателей, Веб-мессенджер или чат для технических писателей
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
20.01.2015 15:19:55
[QUOTE]TatLeo пишет:
Как зайти в веб-мессенджер? По ссылке в правом верхнем углу форума открывается данная ветка. [/QUOTE] См. скриншот:
Изменено: techwriter - 20.01.2015 15:20:27
|
|
|
|
Акция: Поделись шаблонами!
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
20.01.2015 14:31:09
[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] |
|
|
|
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
20.01.2015 12:57:28
Добрый день! Документ "Описание программы" разрабатывается в соответствии с требованиями ГОСТ 19.402-78. Какие именно разделы вам непонятны?
techwriter.ru.com
|
||
|
|
|
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
|
techwriter
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
19.01.2015 11:34:40
Калькулятор тарифного плана?
techwriter.ru.com
|
||
|
|
|
С Новым 2015 годом!
|
Наталья
Эксперт
Сообщений:
Баллов: 826
Регистрация: 05.08.2013
|
15.01.2015 09:08:38
techwriter.ru.com
|
||
|
|
|
С Новым 2015 годом!