|
|
Регистрация Восстановить пароль |
Регистрация | Задать вопрос |
Заплачу за решение |
Новые сообщения |
Сообщения за день |
Расширенный поиск |
Правила |
Всё прочитано |
|
Опции темы | Поиск в этой теме |
18.10.2013, 17:39 | #1 |
Участник клуба
Регистрация: 07.07.2009
Сообщений: 1,385
|
Создание пользовательской документации для ПО: возможна ли автоматизация процесса?
У меня возник наивный вопрос, связанный с созданием пользовательской документации (с нуля) для программного обеспечения.
Я нашла стандарты, по которым создается пользовательская документация (какие части должны быть в документе, как они оформляются и т.д.). Наверное есть средства, которые могут автоматизировать этот безусловно важный, но порой такой нудный процесс - создание User Manual. Какими средствами Вы сами пользуетесь? В Интернете я видела ссылку и учебные материалы для программы dr.Explain. Да, средство мощное, но тестовая версия (trial) не полная, с обрезанным функционалом. А это значит, там нельзя красиво разверстать шпаргалку для пользователя по тем же контролам (для чего какая кнопочка на форме нужна), такая функция есть только в полной платной версии, что делает в принципе бессысленным установку тестовой версии данного программного средства. Может быть, есть иные достойные программы для подобных целей? Жду от Вас дельных советов, в том числе ссылок на хорошие примеры, которым можно было бы следовать при написании пользовательской документации. Образцов в Интернете много, но они не всегда удачны с профессиональной точки знения. И также было бы интересным, каких стандартов придерживаетесь лично Вы?
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan
Последний раз редактировалось Blondy; 18.10.2013 в 18:07. |
18.10.2013, 23:58 | #2 | |
Старожил
Регистрация: 29.09.2009
Сообщений: 9,713
|
ЕСКД, ГОСТ и ТУ в части оформления и наличия необходимых разделов. В этом плане все унифицировано и просто создается один раз рыба (шаблон) для заданной области, по которой в дальнейшем и работают (составляют документацию).
Все остальное - процесс творческий и алгоритмизации не подлежит. Цитата:
Разработки и научно-технические публикации :: Видеоблог :: Твиттер
Radar systems engineer & Software developer of industrial automation |
|
19.10.2013, 19:31 | #3 |
Просветитель
Участник клуба
Регистрация: 26.12.2012
Сообщений: 1,829
|
У меня не совсем пользовательская документация, скорее аналог MSDN. Давным-давно решил для него делать собственный инструмент. Пока не сделал.
В разработке: воспроизводственный контур ИТ
|
20.10.2013, 17:40 | #4 |
Участник клуба
Регистрация: 07.07.2009
Сообщений: 1,385
|
Дорогой 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
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan
|
20.10.2013, 23:15 | #5 | |
Старожил
Регистрация: 29.09.2009
Сообщений: 9,713
|
Cейчас, работает.
Цитата:
Разработки и научно-технические публикации :: Видеоблог :: Твиттер
Radar systems engineer & Software developer of industrial automation |
|
21.10.2013, 12:32 | #6 | |
Участник клуба
Регистрация: 07.07.2009
Сообщений: 1,385
|
Цитата:
Ваша ссылка, дорогой raxp, работает. Еще раз спасибо!
"Все мы жаждем чудес. Чисто человеческое свойство." Carl Sagan
Последний раз редактировалось Blondy; 21.10.2013 в 14:06. |
|
13.02.2018, 18:16 | #7 | |
Новичок
Джуниор
Регистрация: 13.02.2018
Сообщений: 1
|
Коллеги, увидел на форуме обсуждение нашей программы Dr.Explain, хоть и немного устаревшее.
Надеюсь, не сочтете меня некропостером, но захотелось ответить на некоторые из ваших вопросов. Цитата:
Если у вас что-то не работает так, как ожидается - напишите нам в тех.поддержку. Она русскоязычная и очень отзывчивая. Начиная с версии 5.5, Dr.Explain поддерживает написание руководства пользователя по ГОСТу "из коробки". Мы добавили этот функционал по просьбам именно отечественных пользователей. На нашем русскоязычном сайте есть целая статья о том, как работает поддержка ГОСТ в Dr.Explain. Я боюсь давать прямую ссылку на нее, т.к. это мой первый пост на форуме и я боюсь, что внешнюю ссылку в первом же посте сочтут спамом. Найти статью на сайте не сложно. В целом, с 2013 года программа сильно изменилась и улучшилась. Предлагаю тем, кому нужно писать пользовательскую документацию еще раз обратить на нее внимание. Я и наша команда готовы ответить на любые ваши вопросы - тут на форуме, или при обращении в поддержку. |
|
Похожие темы | ||||
Тема | Автор | Раздел | Ответов | Последнее сообщение |
создание документации .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 |