Вид документа для описания отчета

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

Зарегистрируйтесь

RSS

Вид документа для описания отчета, К какому типу отнести документ?

rh3b

Не определившийся

Сообщений: 3 Баллов: 1 Рейтинг: 6 Авторитет: 0 Регистрация: 03.08.2016

Мне нравится0

03.08.2016 11:51:51

Коллеги, приветствую!
Подскажите, пожалуйста, к какому из видов документов следует отнести описание работы отчета в системе.
Т.е. доработан новый функционал (в данном случае отчет) и под него следует создать документ для пользователей.

Ranaloc

Студент

Сообщений: 58 Баллов: 46 Рейтинг: 4 Авторитет: 0 Регистрация: 02.02.2016

Мне нравится0

03.08.2016 12:39:33

Как по мне, так это Release notes (Изменения в работе системы, Обновления в системе и т.п.). Я делаю обычный текстовый документ с подробным описанием того, что появилось, исчезло или изменилось в системе. И потом вношу соответствующие изменения в общие мануалы.

*дальше будет крик души, простите-извините*
А потом делаю общую рассылку и через месяц начинаются разговоры типа:
- Что это такое и как оно работает?! О_О
- Это новый функционал, полное описание его работы было разослано всем сотрудникам месяц назад.
- Что было сделано? Куда разослано? Какие файлы? Не было ничего!

Просто вот только что клиентский отдел возмущался, что им ни про что не рассказывают. Обидно.

Изменено: Ranaloc - 03.08.2016 12:51:42

TechW

Эксперт

Сообщений: 106 Баллов: 584 Рейтинг: 11 Авторитет: 11 Регистрация: 25.07.2013

Мне нравится0

04.08.2016 09:44:25

rh3b, у нас отчетов много и разработан отдельный документ - Альбом отчетных форм (там и параметры отчетов и описание полей). Если отчет один, то я бы добавила его в руководство/ инструкцию.

А об изменениях функционала - да, в Release Notes (История версий).

Ranaloc, попробуйте при каждом удобном случае напоминать о том что ежемесячно выходит Relese Notes (до идиотизма, пряники всем кто запомнил).

rh3b Не определившийся Сообщений: 3 Баллов: 1 Рейтинг: 6 Авторитет: 0 Регистрация: 03.08.2016	#4 Мне нравится0 04.08.2016 09:53:50 Спасибо всем за помощь.

Ranaloc

Студент

Сообщений: 58 Баллов: 46 Рейтинг: 4 Авторитет: 0 Регистрация: 02.02.2016

Мне нравится0

04.08.2016 10:04:56

Цитата
TechW написал: Ranaloc , попробуйте при каждом удобном случае напоминать о том что ежемесячно выходит Relese Notes (до идиотизма, пряники всем кто запомнил).

Лучше кнут тем, кто не запомнил

writer

Администратор

Сообщений: 1890 Баллов: 2422 Рейтинг: 25 Авторитет: 25 Регистрация: 03.04.2007

Мне нравится0

05.08.2016 13:29:39

Цитата

Ranaloc написал:

Цитата
Лучше кнут тем, кто не запомнил

Точно!

R-Magistr Не определившийся Сообщений: 3 Баллов: 1 Рейтинг: 5 Авторитет: 0 Регистрация: 10.08.2016	#7 Мне нравится0 10.08.2016 08:04:33 Скажите пожалуйста, а как аргументировать выбор тех или иных ГОСТ'ов для написания документации к программному обеспечению? Т.е. я пытаюсь сейчас решить ту же задачу, пришёл к тому, что нужно выбрать ГОСТ'ы, но самих гостов то же как оказалось не маленькое количество, и какой из них выбрать, а самое главное надо будет объяснить внятно, почему я выбрал именно этот ГОСТ. Подскажите пожалуйста

Читают тему