Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Вид документа для описания отчета, К какому типу отнести документ?
 
Коллеги, приветствую!
Подскажите, пожалуйста, к какому из видов документов следует отнести описание работы отчета в системе.
Т.е. доработан новый функционал (в данном случае отчет) и под него следует создать документ для пользователей.
 
Как по мне, так это Release notes (Изменения в работе системы, Обновления в системе и т.п.). Я делаю обычный текстовый документ с подробным описанием того, что появилось, исчезло или изменилось в системе. И потом вношу соответствующие изменения в общие мануалы.


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

Просто вот только что клиентский отдел возмущался, что им ни про что не рассказывают. Обидно.
Изменено: Ranaloc - 03.08.2016 12:51:42
 
rh3b, у нас отчетов много и разработан отдельный документ - Альбом отчетных форм (там и параметры отчетов и описание полей). Если отчет один, то я бы добавила его в руководство/ инструкцию.

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

Ranaloc, попробуйте при каждом удобном случае напоминать о том что ежемесячно выходит Relese Notes (до идиотизма, пряники всем кто запомнил).
 
Спасибо всем за помощь.
 
Цитата
TechW написал:
Ranaloc , попробуйте при каждом удобном случае напоминать о том что ежемесячно выходит Relese Notes (до идиотизма, пряники всем кто запомнил).
Лучше кнут тем, кто не запомнил :)  
 
Цитата
Ranaloc написал:
Цитата
Лучше кнут тем, кто не запомнил
Точно!
 
Скажите пожалуйста, а как аргументировать выбор тех или иных ГОСТ'ов для написания документации к программному обеспечению? Т.е. я пытаюсь сейчас решить ту же задачу, пришёл к тому, что нужно выбрать ГОСТ'ы, но самих гостов то же как оказалось не маленькое количество, и какой из них выбрать, а самое главное надо будет объяснить внятно, почему я выбрал именно этот ГОСТ.
Подскажите пожалуйста
Страницы: 1
Читают тему