Оставить заявку

Виктор Фигурнов (Все сообщения пользователя)

Форум » Пользователи » Виктор Фигурнов

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

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 2 3 4 5 6 7 8 9 10 11 12 След.
Подготовка паспорта проекта, что это?, паспорта проекта
 
Паспорт проекта это документ, содержащий основные текстовые данные и схематические изображения, характеризующие проект, его цели и задачи, способы реализации, технические, финансовые и прочие показатели, используемые технические и технологические решения, планируемые результаты и экономические эффекты, экономическую целесообразность, условия применения и т. д.

Конкретные требования к паспорту проекта зависят от вида проекта.

См. например, Методические рекомендации по подготовке Паспорта инвестиционного проекта для участия в Программе поддержки инвестиционных проектов, реализуемых на территории Российской Федерации на основе проектного финансирования  
Quick Start Guide на русском, наиболее уместный перевод названия документа
 
[QUOTE]H&M User написал:
Читайте выше, оператор = пользователь, т.е. руководство пользователя по 19 ГОСТ называется руководство оператора, которое ничего общего не имеет с Вашими операторами.
[/QUOTE]
Картина маслом: H&M User втирает нормоконтролеру, что по [COLOR=#373737]19 ГОСТ руководство для пользователя якобы должно делаться по [COLOR=#696969]ГОСТ 19.505-79 "Руководство оператора"
[/COLOR][/COLOR]
Нормоконтролер спросит: где именно в ГОСТ 19 серии вы это вычитали? Покажите! - И что вы покажете?
Потом нормоконтролер ткнет вас в то, что в ГОСТ 19 русским по белому написано, что пользователь это вообще не человек, а "предприятие-держатель дубликата". :) Кстати, Вы знаете, что это такое?  :)

И еще вопрос: если [COLOR=#373737][COLOR=#696969][COLOR=#373737]руководство для пользователя должно делаться по [COLOR=#696969]ГОСТ 19.505-79 "Руководство оператора", то как должно делаться руководство для [/COLOR]оператора, и чем оно должно отличаться от руководства пользователя?[/COLOR][/COLOR][/COLOR]

[COLOR=#373737][QUOTE]H&M User написал:
Не путайте понятия оператора и оператора ЭВМ.
[/QUOTE]
[/COLOR]Я ничего не путаю. В середине 1970-х гг., когда разрабатывались стандарты ГОСТ 19, а вас еще в проекте не было, оператор в 99% случаев и был оператором ЭВМ. Именно его функции исчерпывающе описаны в [COLOR=#696969]ГОСТ 19.505-79 "Руководство оператора". Оператор ЭВМ должен был определять, имеются ли условия для запуска программы, выполнять нужные действия для запуска программы - ставить и монтировать нужные программе магнитные диски, магнитные ленты, отправлять на считывание колоды перфокарт или перфоленты, выделять разделы для рабочих областей на дисках и т.п., отвечать на консоли на запросы программы, выполнять рестарт программы при сбое и т.п.,[/COLOR]

[QUOTE]H&M User написал:
Руководство системного программиста по 19 ГОСТ это руководство АДМИНИСТРАТОРА, для программистов и системных программистов существует руководство ПРОГРАММИСТА.
[/QUOTE]
На каком нормативном документе основано это ваше заявление? Как вы объясните нормоконтролеру вопиющее несоблюдение стандартов - создание руководства администратора по  ГОСТ 19.503-79 "Руководство системного программиста", а  руководства системного программиста не по  ГОСТ 19.503-79 "Руководство системного программиста", а по  ГОСТ 19.504-79 "Руководство программиста"?

Если вы считаете, что в ГОСТ 19.503-79 "Руководство системного программиста" описаны функции администратора, то это не так. Функции персонажа, для которого написан этот архаический ГОСТ,  сейчас выполняют как минимум три человека: специалист по внедрению/развертыванию (deployment manager), администратор и тестировщик.[QUOTE]H&M User написал:
. Если 19 ГОСТ требует заказчик[/QUOTE]
Любой каприз за ваши деньги, любой идиотизм под подпись. Если заказчик желает соблюдения регламентов петровских времен, и готов за это платить, никаких проблем.  :D
Quick Start Guide на русском, наиболее уместный перевод названия документа
 
[QUOTE]H&M User написал:
[QUOTE]оператор = пользователь, а системный программист = администратор
... Это для документации по 19 ГОСТ.[/QUOTE]
[/QUOTE]
Сорри за офтопик. У меня сейчас в работе документация по онлайн-сервису.

С сервисом работают как пользователи, так и операторы. Причем двух видов - оператор сервиса и оператор службы поддержки сервиса.
Задачи, функции, потребности и необходимые сведения для работы с сервисом у них разные.
И они не имеют практически ничего общего с предписаниями ГОСТ 19.505-79 "Руководство оператора"

С сервисом работают как системные программисты, так и администраторы.
Задачи, функции, потребности и необходимые сведения для работы с сервисом у них разные.
И они не имеют практически ничего общего с предписаниями ГОСТ 19.503-79 "Руководство системного программиста"

Я считаю крайне нежелательным в угоду мракобесам, вооруженным средневековыми ГОСТами, существенно ухудшать качество продукта, смешивая разные понятия, используя давно ушедшую в небытие IT-терминологию 40-летней давности и включая в документацию громадное количество совершенно не нужных сведений лишь только потому, что 40 лет назад была другая профессия с тем же названием, и для нее в ГОСТе 40-летней давности, написанном под реалии 40-50 летней давности, было предписано сообщать эти сведения.
Изменено: Виктор Фигурнов - 17.07.2015 12:12:05
Quick Start Guide на русском, наиболее уместный перевод названия документа
 
[QUOTE]H&M User написал:
Если спросить у дядюшки Гугля,...:
1) "Начало работы с" - 25 000 000 ссылок;
2) "Руководство по началу работы" - 829 000 ссылок;
3) "Быстрый старт" - 625 000 ссылок;
4) "Руководство по быстрому старту" - 438 000 ссылок.

[/QUOTE]
Неправильно спрашивали. В данном случае надо искать не набор слов - при таком поиске искомые слова могут быть размещены в любом порядке, в любых грамматических формах и в любых частях веб-страницы, в т.ч. по отдельности, будут найдены и однокоренные слова. Например, запрос № 1 находит страницы с фразами:[QUOTE]Начало литературной работы
Следствие начало поиски причин гибели рабочих на винодельне [/QUOTE]
и т.п.

Следует искать точные словосочетания. Для этого искомую фразу в Гугле надо заключить в кавычки. Тогда получаются такие результаты:
[COLOR=#373737]1) "Начало работы с" — [COLOR=#808080][B]367 000[/B][/COLOR] ссылок;[/COLOR]
[COLOR=#373737]2) "Руководство по началу работы" —[B] [/B][COLOR=#808080][B]59 600[/B] [/COLOR]ссылок;[/COLOR]
[COLOR=#373737]3) "Быстрый старт" — [B]564 000[/B] ссылок;[/COLOR]
[COLOR=#373737]4) "Руководство по быстрому старту" — [B]14 100[/B] ссылок.[/COLOR]
Quick Start Guide на русском, наиболее уместный перевод названия документа
 
[QUOTE]H&M User написал:
можете даже не спрашивать, почему оператор = пользователь, а системный программист = администратор
[/QUOTE]
[COLOR=#373737]Администратор имеет мало шансов устроиться на вакансию системного программиста, и наоборот. [/COLOR]
Как улучшить и оптимизировать разработку документации, Обсуждаем возможности улучшения , ускорения и повышения качества документации
 
[QUOTE]Текрайтер из Питера написал:
Например, уменьшение запросов в службу поддержки на N%.
[/QUOTE]
Этот показатель зависит от множества факторов. Выделить из них влияние технических писателей затруднительно.
ГОСТ или корпоративные стандарты
 
[QUOTE]''ivs0'' написал:
А вот составить качественные документы по уже разработанной программе - это ГОСТ 19 серии. А чем определяется качество? Правильно - требованиями. А кто к документам предъявил требования - правильно - заказчик.[/QUOTE]
Не путайте качество и соблюдение требований заказчика.
О том что такое качество программного обеспечения и каковы критерии его оценки, см. например стандарт ISO 25010-2011

[QUOTE]''ivs0'' написал:
Заказчик не предложил? Тогда как проверить качество? Вот для этого есть ГОСТ.[/QUOTE]
Как ГОСТ 1977-1980 г., написанные для совершенно иных реалий, могут использоваться для проверки качества документации на современные информационные системы? Например, вам надо написать документацию на онлайн-сервис, в его разработке, установке, эксплуатации, обновлении задействованы многие десятки людей разных специальностей. Для которых надо подготавливать отдельные документы, о которых ничего не говорится в ГОСТах 19 серии. А персонажей из реалий 1970--х гг., для которых ГОСТЫ 19 серии предписывают писать руководства, сейчас вообще не существует. Даже если какие-то люди имеют те же названия должностей, они сейчас выполняют совсем не те функции, которые предполагаются в ГОСТах 1970-х гг.

[QUOTE]''ivs0'' написал:
Если "коробочная" программа - ГОСТ Р ИСО 9127-94. [/QUOTE]
ГОСТ [COLOR=#373737]Р ИСО 9127-94. это перевод давно отмененного стандарта ISO 9127-1988, 1988 года. Сейчас действует стандарт ISO 26514-2008.
[/COLOR]
[QUOTE]'ivs0'' написал:
приемку документов осуществляем по этому ГОСТ.[/QUOTE]
И получаете такие "ценные документы", как "Формуляр", "Руководство системного программиста", "Руководство программиста", "Руководство оператора", "Описание языка" и пр.

Если ГОСТы серии 19 имеют какую-то ценность, то почему Google, Apple, Microsoft и прочие крупнейшие фирмы разработчики их не применяют? :)

Вам не кажется, что требование применения ГОСТов 1970-х гг. к современной IT-продукции, в корне отличающейся от того, что было в 1970-е годы, это вредительство и путь к отсталости навсегда?
Изменено: Виктор Фигурнов - 09.07.2015 12:55:38
ГОСТ или корпоративные стандарты
 
Хотел бы отметить, что ГОСТ 19 серии приняты в 1978-80 гг, а разрабатывались начиная с 1973 года. Т.е. они отражают реалии 1960-х - начала 1970 гг.
ГОСТ или корпоративные стандарты
 
[QUOTE]Ден написал:
[QUOTE]Теперь будет на что ссылаться, если будут требовать соблюдение ГОСТ. Даже не знал о таком законе.
[/QUOTE]
[/QUOTE]
Учтите, что кроме ГОСТов, есть еще технические регламенты. [URL=https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B9_%D1%80%D0%B5%D0%B3%D0%BB%D0%B0%D0%BC%D0%B5%D0%BD%D1%82]https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B9_%D1...[/URL]
Соблюдение технических регламентов обязательно. Многие технические регламенты содержат требования к документации.
Если объект, по которому создается документация, подпадает под действие какого-то технического регламента, то требования к документации этого регламента придется целиком и полностью выполнять.
ГОСТ или корпоративные стандарты
 
Согласно Закону "О техническом регулировании", от 27.12.2002 N 184-ФЗ,
[I][B]стандарт (в том числе и ГОСТ)[/B] — документ, в котором [B][COLOR=#ee1d24]в целях добровольного многократного использования[/COLOR][/B] устанавливаются характеристики продукции, правила осуществления и характеристики
[/I]
Поэтому если вы или ваша организация добровольно соблюдает какие-то положения ГОСТ, или ваш заказчик требует соблюдения ГОСТ, то и соблюдайте их. Флаг вам в руки.
А в остальных случаях эти ГОСТы соблюдать не обязательно.

Но в ГОСТах есть много здравого, такого, что соблюдать очень даже полезно. Хотя в них есть и немало устаревших и откровенно идиотских требований.
Далеко не все ГОСТы созданы в 1980-х гг., есть много современных. Например:

ГОСТ Р ИСО 15910-2002 Процесс создания документации пользователя программного средства
ГОСТ Р ИСО 12207-2010 Процессы жизненного цикла программных средств
ГОСТ Р ИСО 15288-2005 Процессы жизненного цикла систем
ГОСТ Р 53622-2009 Информационные технологии. Информационно-вычислительные системы. Стадии и этапы жизненного цикла, виды и комплектность документов
ГОСТ Р ИСО/МЭК 20000-1-2013 Информационная технология. Управление услугами. Часть 1.
ГОСТ Р 52292-2004 Информационная технология. Электронный обмен информацией. Термины и определения
ГОСТ Р 53624-2009 Информационные технологии. Информационно-вычислительные системы. Программное обеспечение. Системы менеджмента качества. Требования
ГОСТ Р ИСО 14764-2002 Сопровождение программных средств
ГОСТ Р ИСО 15489-2007 Управление документами, общие требования
ГОСТ Р ИСО 27001-2006 Системы менеджмента информационной безопасности. Требования
и т.д.

Также очень много ценного имеется в стандартах ISO и IEEE. Например, по пользовательской документации я бы обратил внимание на стандарты:
ISO 26514-2008 - Requirements for designers and developers of user documentation
ISO 26511-2012 - Requirements for managers of user documentation
ISO 26512-2011 - Requirements for acquirers and suppliers of user documentation
ISO 15289-2015 - Content of life-cycle information products (documentation)
Изображения по ГОСТ
 
Смотря для какого документа. Вот, например:
ГОСТ 2.105-95 ЕСКД. Общие требования к текстовым документам
ГОСТ 7.32-2001 ОТЧЕТ О НАУЧНО-ИССЛЕДОВАТЕЛЬСКОЙ РАБОТЕ
ГОСТ 19.106-78 (СТ СЭВ 2088-80). ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ,  ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
ГОСТ Р 21.1101-2009 Система проектной документации для строительства. ОСНОВНЫЕ ТРЕБОВАНИЯ К ПРОЕКТНОЙ И РАБОЧЕЙ ДОКУМЕНТАЦИИ
ГОСТ Р 7.0.11-2011 Диссертация и автореферат диссертации. Структура и правила оформления
Изменено: Виктор Фигурнов - 22.06.2015 17:42:09
Общий вопрос по программам для разработки документации
 
[QUOTE]''Dr.Explain'' написал:
Добрый день,

примеры интеграции и приведенные фрагменты кода можно считать универсальными.[/QUOTE]

Примеры и фрагменты очень ясные и подробные.
 
Но использование формата встроенной справки CHM я бы крайне не рекомендовал.

От формата CHM его разработчик (Microsoft) отказался еще в 2002 году, этот формат имеет массу проблем и ограничений.
Общий вопрос по программам для разработки документации
 
[QUOTE]Elanor написал:
Коллеги, у меня появился вопрос для тех, кто пользуется программами для разработки документации, в частности - встроенной справки.
А каким образом в таком редакторе страница справки может быть привязана к форме в программе?
Нужно, чтобы написанная страница открывалась по нажатии F1 или кнопки "Справка".

Предоставляют ли существующие программы такую возможность?
Как это обычно реализуется?[/QUOTE]

Да, все ведущие программы для создания документации поддерживают такую возможность. Общая идеология такая, что топику или конкретному месту в нем присваивается некий TopicID (обычно число), и программа обращается к справке используя этот Topic ID, используя вызов по URL, через JavaScript или с помощью специального API для обращения к справке. Формат справки который может вызываться из программы - WebHekp, HTML5 Help, Mobile Help, Dotnet Help и др. Обычно поддерживается возможность создания hesder-файлов, содержащих сопоставления названия топиков и их номеров.

Madcap Flare:
[URL=http://webhelp.madcapsoftware.com/flare11/Content/CSH/About_Context_Sensitive_Help.htm]http://webhelp.madcapsoftware.com/flare11/Content/CSH/About_Context_Sensitive_Help.htm[/URL]

Robohelp:
[URL=http://help.adobe.com/en_US/robohelp/robohtml/WS5b3ccc516d4fbf351e63e3d11aff59c571-8000.html]http://help.adobe.com/en_US/robohelp/robohtml/WS5b3ccc516d4fbf351e63e3d11aff59c571-8000.html[/URL]

H&M
[URL=http://www.helpandmanual.com/help/hm_ref_contextpop_implement.htm]http://www.helpandmanual.com/help/hm_ref_contextpop_implement.htm[/URL]
Очепятки, смешные инструкция, добавляем найденные опечатки, о том как не нужно писать
 
Цитата
Elanor написал:
слово «пескарь» в этой сказке традиционно пишется через «и» — «пискарь»,
Отсюда и фамилия "Пискарев". :)
Новая версия стандарта ISO/IEC/IEEE 15289 по документации жизненного цикла информационных систем и программного обеспечения
 
Сегодня вышла новая версия стандарта ISO/IEC/IEEE 15289:2015 Системная и программная инженерия. Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация).

Предыдущие версии этого стандарта были выпущены в 2006 и 2011 гг.

Стандарт описывает 7 видов и 92 конкретных типов документации, используемых на протяжении жизненного цикла информационных систем и программного обеспечения, описывает требования к их содержанию, указывает соответствия этих типов документации и информационных продуктов, описанных в стандартах жизненного цикла информационных систем, стандартах жизненного цикла программных продуктов, стандартах на процессы управления услугами.

Ссылки:
[URL=http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=66422]http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=66422[/URL]

[URL=https://standards.ieee.org/findstds/standard/15289-2015.html]https://standards.ieee.org/findstds/standard/15289-2015.html[/URL]
Изменено: Виктор Фигурнов - 22.05.2015 10:54:56
Техническая документация на ПО, Нужна помощь
 
Светлана, а вы лично работали с этой программой (веб-сервисом)? Умеете ее устанавливать и настраивать?

В другом сообщении вы писали, что требуется написать "инструкции по установке и настройке, ответы на часто задаваемые вопросы"

Надеюсь, вы понимаете, что установка и настройка веб-сервиса, и использование веб-сервиса — это разные функции, которые выполняются разными людьми, которые, возможно не знакомы и находятся во многих тысячах километров друг от друга? Пользователь обычно не занимается установкой и настройкой сервиса, а установщик (администратор) - не использует сервис, кроме целей проверки его работоспособности, оценки производительности и т.п. (и даже эти действия могут выполнять другие люди). Поэтому установку/настройку и использование веб-сервиса принято описывать в разных документах, а не в одном "руководстве пользователя".
Изменено: Виктор Фигурнов - 20.05.2015 12:40:44
Техническая документация на сервис, Нужна помощь
 
Насколько я понимаю, это тестовое задание, возможно фирмы MachineZone.
Сделано формально, по аналогии с тестовым заданием для программистов [URL=http://machinezone.ru/challenges/resource-manager]http://machinezone.ru/challenges/resource-manager[/URL].
Алфавитно-предметный указатель, нужен ли в электронной документации?
 
Я пользуюсь, когда такой указатель есть. Поиск может выдавать сотни результатов, а толково сделанный указатель даст наиболее релевантные ссылки.
"Клик" на планшете или смартфоне
 
Посмотрите здесь:
[URL=http://www.windowsphone.com/ru-ru/how-to/wp7/start/gestures-flick-pan-and-stretch]http://www.windowsphone.com/ru-ru/how-to/wp7/start/gestures-flick-pan-and-stretch[/URL]
Яндекс организует конференцию для разработчиков документации 18 апреля
 
Цитата
H&M User написал:

Непонятно, что же там полезного в этой строке

Типа круто. Если человек с DITA смог работать, то и с H&M тем более разберется. Но не наоборот.
Вакансия Технический писатель / Аналитик - Москва, Крупная компания-разработчик ПО, лидер в своей отрасли
 
Среднемесячная заработная плата в Москве, по данным Росстата на февраль 2015 г. - [B]56095 [/B]рублей.

На этом фоне предлагаемая зарплата в 63000 рублей за работу аналитика и технического писателя мне не кажется адекватной.

Тем более для "[COLOR=#000000]Крупной компании-разработчика ПО, лидера в своей отрасли".[/COLOR]
Изменено: Виктор Фигурнов - 22.04.2015 10:35:26
Яндекс организует конференцию для разработчиков документации 18 апреля
 
Цитата
TechW написал:
DITA - это голый xml, а остальное ПО - наряженный xml.
DITA это не ПО. Это основанная на XML модель хранения данных для технической документации.
Весьма сложная и замороченная.
Эталонной реализации DITA нет.
Есть DITA Open Tookit, который конвертирует исходники DITA в PDF, HTML5, XHTML, Eclipse Help, HTML Help, Java Help, ODT, RTF.
Организации, которые хотят помучиться, делают свою схему обработки данных, основанную на модели DITA
Например Яндекс.
При этом приходится много чесать в затылке и работать напильником, чтобы связать друг с другом разные тулзы и дорабатывать их.
И потом долго и постоянно учить людей пользоваться той конструёвиной, которая получилась.

Остальное ПО для техдокументации часто использует XML или XHTML для хранения данных.
Но там XML это просто формат хранения данных. Удобный, открытый и т.п.
Основная ценность ПО для техдокументации не в том, что оно использует XML, а в том что оно:
  • автоматизирует технологические процессы создания документации на базе модели единого источника.
  • обеспечивает средства коллективной работы над документацией
  • обеспечивает интеграцию с системами перевода, средства рецензирования, контроля качества и др.
  • и все это в простой, удобной и наглядной форме.


 
Сроки и время на разработку документации, Сроки и время на разработку документации
 
Сильно зависит от приложения, его сложности, функциональности, сценариев применения, необходимых руководств и т.д.
Документирование простейшего приложения потребует пару дней работы одного человека.
Сложное приложение, например, система комплексной автоматизации деятельности банка, потребует создания десятков руководств, достаточно сложных, объемом в много тысяч или десятков тысяч страниц.
Тут для документирования могут понадобиться десятки человеко-лет работы.
Многоуровневые списки, практика оформления многоуровневых списков
 
Стандарт ГОСТ 2.105 следует употреблять, если вы разрабатываете документацию для машиностроения, приборостроения и строительства, и применение ГОСТ 2 для вас обязательно.
Если вы разрабатываете отчет по НИР, то перечни надо оформлять по ГОСТ 7.32-2001.
В остальных случаях следует руководствоваться требованиями заказчика, корпоративными стандартами и пр., если они этот вопрос регламентируют.
Если не регламентируют - возьмите Справочник издателя и автора А.Мильчина и Л.Чельцовой, 4-е изд., [URL=http://www.ozon.ru/context/detail/id/27184063/]http://www.ozon.ru/context/detail/id/27184063/[/URL]
и посмотрите как там советуют оформлять перечни.
Печать из графических файлов в текстовой, Печать из графических файлов( скан, pdf и др.) в редактируемый Word
 
Программа распознавания текстов ABBYY Finereader

Позволяет извлекать текстовые данные и картинки из цифровых изображений (фотографий, результатов сканирования) и PDF-файлов, и сохраняет результаты в форматах Microsoft Word, RTF, HTML, PDF, DJVU, plain text и др.

https://finereaderonline.com/ru-ru  Онлайн-сервис ABBYY Finereader.
До 10 страниц распознается бесплатно, и далее 5 страниц в месяц бесплатно. 1000 страниц в месяц 599 рублей.

http://shop.abbyy.ru/fr12_pro/ - 5290 руб. - бессрочная лицензия на программу ABBYY Finereader на 1 компьютер.
Изменено: Виктор Фигурнов - 27.03.2015 10:00:25
Страницы: Пред. 1 2 3 4 5 6 7 8 9 10 11 12 След.

Рейтинг@Mail.ru