Форум программистов
 

Восстановите пароль или Зарегистрируйтесь на форуме, о проблемах и с заказом рекламы пишите сюда - alarforum@yandex.ru, проверяйте папку спам!

Вернуться   Форум программистов > IT форум > Общие вопросы по программированию, компьютерный форум
Регистрация

Восстановить пароль
Повторная активизация e-mail

Купить рекламу на форуме - 42 тыс руб за месяц

Ответ
 
Опции темы Поиск в этой теме
Старый 18.10.2013, 17:39   #1
Blondy
Участник клуба
 
Аватар для Blondy
 
Регистрация: 07.07.2009
Сообщений: 1,386
По умолчанию Создание пользовательской документации для ПО: возможна ли автоматизация процесса?

У меня возник наивный вопрос, связанный с созданием пользовательской документации (с нуля) для программного обеспечения.

Я нашла стандарты, по которым создается пользовательская документация (какие части должны быть в документе, как они оформляются и т.д.). Наверное есть средства, которые могут автоматизировать этот безусловно важный, но порой такой нудный процесс - создание User Manual. Какими средствами Вы сами пользуетесь?

В Интернете я видела ссылку и учебные материалы для программы dr.Explain. Да, средство мощное, но тестовая версия (trial) не полная, с обрезанным функционалом. А это значит, там нельзя красиво разверстать шпаргалку для пользователя по тем же контролам (для чего какая кнопочка на форме нужна), такая функция есть только в полной платной версии, что делает в принципе бессысленным установку тестовой версии данного программного средства. Может быть, есть иные достойные программы для подобных целей?

Жду от Вас дельных советов, в том числе ссылок на хорошие примеры, которым можно было бы следовать при написании пользовательской документации. Образцов в Интернете много, но они не всегда удачны с профессиональной точки знения.

И также было бы интересным, каких стандартов придерживаетесь лично Вы?
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan

Последний раз редактировалось Blondy; 18.10.2013 в 18:07.
Blondy вне форума Ответить с цитированием
Старый 18.10.2013, 23:58   #2
raxp
Старожил
 
Регистрация: 29.09.2009
Сообщений: 9,742
По умолчанию

ЕСКД, ГОСТ и ТУ в части оформления и наличия необходимых разделов. В этом плане все унифицировано и просто создается один раз рыба (шаблон) для заданной области, по которой в дальнейшем и работают (составляют документацию).

Все остальное - процесс творческий и алгоритмизации не подлежит.

Цитата:
ссылок на хорошие примеры, которым можно было бы следовать при написании пользовательской документации
http://raxp.radioliga.com (прожекты и поддержка/примеры технических описаний и инструкций программиста и вниз)
Разработки и научно-технические публикации :: Видеоблог :: Твиттер
Radar systems engineer & Software developer of industrial automation
raxp вне форума Ответить с цитированием
Старый 19.10.2013, 19:31   #3
Vapaamies
Ваш К. О.
Участник клуба
 
Аватар для Vapaamies
 
Регистрация: 26.12.2012
Сообщений: 1,755
По умолчанию

Цитата:
Сообщение от Blondy Посмотреть сообщение
И также было бы интересным, каких стандартов придерживаетесь лично Вы?
У меня не совсем пользовательская документация, скорее аналог MSDN. Давным-давно решил для него делать собственный инструмент. Пока не сделал.
Vapaamies вне форума Ответить с цитированием
Старый 20.10.2013, 17:40   #4
Blondy
Участник клуба
 
Аватар для Blondy
 
Регистрация: 07.07.2009
Сообщений: 1,386
По умолчанию

Дорогой raxp, к сожалению, Ваш ресурс, представленный в ссылке не пускает меня смотреть примеры. Я захожу по ссылке, вижу дерево/каталог, нажимаю на интересующую ссылку и выдает вывеску, мол, трафик превышен и все такое прочее. Я вывеску прилагаю.

По поводу стандартов: я не случайно спросила, их очень много, вот я нашла международный IEEE Std 1063-2001 IEEE Standard for Software User Documentation, но ему уже в обед сто лет (2001 год), может, есть что-то поновее.

К тому же, стандарты разные бывают. Я не видела под пользовательскую документацию версии ISO, но американские военные (MILITARY STANDARD
SOFTWARE DEVELOPMENT AND DOCUMENTATION) предлагают для цели написания Software User Manual (SUM) некий стандарт DI-IPSC-81443
Изображения
Тип файла: jpg 1.JPG (27.3 Кб, 139 просмотров)
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan
Blondy вне форума Ответить с цитированием
Старый 20.10.2013, 23:15   #5
raxp
Старожил
 
Регистрация: 29.09.2009
Сообщений: 9,742
По умолчанию

Cейчас, работает.

Цитата:
му уже в обед сто лет (2001 год), может, есть что-то поновее.

К тому же, стандарты разные бывают. Я не видела под пользовательскую документацию версии ISO, но американские военные (MILITARY STANDARD
а вы в Америке или Европе работаете? На территории стран СНГ пока что ЕСКД, ГОСТы, ТУ и СТП (стандарты предприятия) никто не отменял.
Разработки и научно-технические публикации :: Видеоблог :: Твиттер
Radar systems engineer & Software developer of industrial automation
raxp вне форума Ответить с цитированием
Старый 21.10.2013, 12:32   #6
Blondy
Участник клуба
 
Аватар для Blondy
 
Регистрация: 07.07.2009
Сообщений: 1,386
По умолчанию

Цитата:
а вы в Америке или Европе работаете?
В Европе (Северная Европа/Скандинавия). Поэтому ГОСТы и прочие российские стандарты для меня при написании пользовательской документации не являются обязательными для строгого соответствия (но это не значит, что из них нельзя подчерпнуть что-то полезного и дельного).

Ваша ссылка, дорогой raxp, работает. Еще раз спасибо!
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan

Последний раз редактировалось Blondy; 21.10.2013 в 14:06.
Blondy вне форума Ответить с цитированием
Старый 13.02.2018, 18:16   #7
indigobyte
Новичок
Джуниор
 
Регистрация: 13.02.2018
Сообщений: 1
По умолчанию

Коллеги, увидел на форуме обсуждение нашей программы Dr.Explain, хоть и немного устаревшее.
Надеюсь, не сочтете меня некропостером, но захотелось ответить на некоторые из ваших вопросов.

Цитата:
Сообщение от Blondy Посмотреть сообщение
В Интернете я видела ссылку и учебные материалы для программы dr.Explain. Да, средство мощное, но тестовая версия (trial) не полная, с обрезанным функционалом. А это значит, там нельзя красиво разверстать шпаргалку для пользователя по тем же контролам (для чего какая кнопочка на форме нужна), такая функция есть только в полной платной версии, что делает в принципе бессысленным установку тестовой версии данного программного средства.
Бесплатная версия Dr.Explain никак не ограничивает функциональность работы с проектом и разделами, в т.ч. с автоматической аннотацией скриншотов. Фактически, единственным ограничением бесплатного режима являются водяные знаки на графике в финальном документе. В остальном сейчас нет ограничений ни по функциям, ни по времени использования.

Если у вас что-то не работает так, как ожидается - напишите нам в тех.поддержку. Она русскоязычная и очень отзывчивая.


Цитата:
Сообщение от raxp Посмотреть сообщение
ЕСКД, ГОСТ и ТУ в части оформления и наличия необходимых разделов.
Начиная с версии 5.5, Dr.Explain поддерживает написание руководства пользователя по ГОСТу "из коробки". Мы добавили этот функционал по просьбам именно отечественных пользователей. На нашем русскоязычном сайте есть целая статья о том, как работает поддержка ГОСТ в Dr.Explain. Я боюсь давать прямую ссылку на нее, т.к. это мой первый пост на форуме и я боюсь, что внешнюю ссылку в первом же посте сочтут спамом. Найти статью на сайте не сложно.

В целом, с 2013 года программа сильно изменилась и улучшилась. Предлагаю тем, кому нужно писать пользовательскую документацию еще раз обратить на нее внимание. Я и наша команда готовы ответить на любые ваши вопросы - тут на форуме, или при обращении в поддержку.
indigobyte вне форума Ответить с цитированием
Ответ


Купить рекламу на форуме - 42 тыс руб за месяц

Опции темы Поиск в этой теме
Поиск в этой теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
создание документации .Net Voipp Общие вопросы .NET 1 23.05.2013 12:52
создание пользовательской функции Devil669 Microsoft Office Excel 1 10.12.2012 23:47
Создание пользовательской формулы Squarded Microsoft Office Excel 3 05.12.2011 17:37
Создание пользовательской формы dreik92 Microsoft Office Excel 0 16.04.2011 02:08
Создание теста в VBA с пом-ью пользовательской формы. HellkilleR Microsoft Office Excel 3 14.04.2010 23:00