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

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

Если изменений было действительно много, если поменялась какая-либо идеология, писать стоит вообще заново.
А что имеется в виду под "руководство пользователя не будет биться с ТЗ"?

Про стандарт. Есть чудный ГОСТ Р ИСО/МЭК 12119-2000, в котором приводятся требования к документации, как то: полнота, правильность, простота обозрения, непротиворечивость. http://testrussia.ru/doc/12119_2000.pdf (стр. 6)
В Вашем вопросе речь как раз про полноту и правильность.
Изменено: Elanor - 22.07.2014 16:03:01
 
Я бы полностью переписала руководство пользователя, а ПМИ написала бы только на функции, перечисленные в ТЗ.
techwriter.ru.com
 
Цитата
Elanor пишет:
Про стандарт. Есть чудный ГОСТ Р ИСО/МЭК 12119-2000, в котором приводятся требования к документации, как то: полнота, правильность, простота обозрения, непротиворечивость.
Этот стандарт ISO уже 8 лет как отменила. Действующий стандарт ISO/IEC 25051:2014 "Software engineering -- Systems and software Quality Requirements and Evaluation (SQuaRE) -- Requirements for quality of Ready to Use Software Product (RUSP) and instructions for testing"
 
Ок, номер изменили. https://www.iso.org/obp/ui/#iso:std:iso-iec:25051:ed-2:v1:en
Не думаю, что в плане требований к полноте и правильности пользовательской документации, требования сильно изменились.
Я писала про стандарт Российской Федерации. У нас 12119 вроде бы действует
http://vsenorm.com/Category/2/2771.htm

Да, не отменен и ни на что не заменен.
Проверила по каталогу гостов Госстандарта http://standard.gost.ru/wps/portal/
Изменено: Elanor - 22.07.2014 17:08:19
 
Цитата
Elanor пишет:
Ок, номер изменили. https://www.iso.org/obp/ui/#iso:std:iso-iec:25051:ed-2:v1:en
Не думаю, что в плане требований к полноте и правильности пользовательской документации, требования сильно изменились.
В новом стандарте 19 требований к документации пользователя, в старом - 5. Да и те 5 требований несколько поменялись. Это сильное изменение или нет?  :D

Цитата
Elanor пишет:
Я писала про стандарт Российской Федерации. У нас 12119 вроде бы действует
Да, к сожалению, в России действует стандарт 20-летней "свежести" - перевод стандарта ISO 1994 года. С тех пор в софтверной индустрии очень много изменилось.
 
Выпускаете новую версию ПО, делайте новую версию документации к этой новой версии.
 
Цитата
Гость пишет:
Вопрос: как писать руководство пользователя, описание автоматизированных функций и программу и методику испытаний? Только на новые функции или руководство пользователя и пми должно описывать все функции, описание автоматизируемых, только те что в ТЗ? Как правильно? По идее документация должна актуализироваться, но тогда руководство пользователя не будет биться с ТЗ. ... Или подскажите, пожалуйста, какой-нибудь стандарт на актуализацию документации.
Обычно для существенно изменившейся версии программы делается новая версия документации, и в нее включается перечень изменений (Release notes), включающий описание новых/изменившихся/удаленных функций.программы. Заменять новую версию документации списком изменений стандарт ISO/IEC 26514:2008 запрещает, так как это трудно воспринимается новыми пользователями.

Стандарты на обновления документации:
ISO/IEC 26514:2008 Systems and software engineering —- Requirements for designers and developers of user documentation, раздел 9.4 "Updating and maintenance"
ISO/IEC/IEEE 26515:2011 Systems and software engineering -- Developing user documentation in an agile environment
 
Цитата
Виктор Фигурнов пишет:
ISO/IEC/IEEE 26515:2011 Systems and software engineering -- Developing user documentation in an agile environment
Стандарт подходит тем, кто по Agile работают.
Изменено: techwriter - 23.07.2014 12:13:55
techwriter.ru.com
Страницы: 1
Читают тему