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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Качество технической документации. Методы оценки
 
Предлагаю в этой теме обсудить то, как можно оценить качество технической документации. Какие существуют методики и приемы.
 
Методика оценки качества программной документации. Отчет по НИР (ротапринт). — М.: РосКЦИТО, 1996г, 61 стр.
 
Цитата
Методика оценки качества программной документации. Отчет по НИР (ротапринт). — М.: РосКЦИТО, 1996г, 61 стр.
Не по теме, как выяснилось. ГОСТ 28195 изучайте. Или... ссылку не дам, а то загрызут меня здесь :)
 
Цитата
Или... ссылку не дам, а то загрызут меня здесь :)
Ни косточки не останется :D ссылки в личной переписке можно отправлять
 
Если по ГОСТу , то можно использовать  Р ИСО/МЭК 15910-2002

[i:2xucscmj] Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 «Информационная технология. Процесс создания документации пользователя программного средства»[/i:2xucscmj]
там достаточно подробно описано как разрабатывать документ, так и как его принимать. рекомендую.
 
Цитата
Если по ГОСТу , то можно использовать  Р ИСО/МЭК 15910-2002

[i:2x57toxh] Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 «Информационная технология. Процесс создания документации пользователя программного средства»[/i:2x57toxh]
там достаточно подробно описано как разрабатывать документ, так и как его принимать. рекомендую.
Кажется, цельнотянутый с австралийского или новозеландского. И там еще в конце написано, что техпис должен писать 20 страниц нового текста в месяц? :) Что-то знакомое :)
 
:)  Всем привет!!!
Если оценивать в баллах, то каким будет проходной? - относительно документации...
Кстати в одном древнем документе, который был выловлен мной в сети интернет (документ описывал работу какого-то ПО РЖД),
были выделены следующие критерии:
Обобщенные требования к документации
К документации предъявляются следующие требования:
•    полнота и понятность документации;
•    достаточность документации для ввода ПО в эксплуатацию;
•    правильность документации;
•    приемлемость уровня технического исполнения документации;
•    наличие краткой аннотации ПО;
•    наличие описания решаемых задач;
•    наличие описания ограничений по применению;
•    наличие описания структуры функций ПО;
•    наличие описания функций ПО;
•    наличие описания алгоритмов;
•    наличие описания пользовательских интерфейсов;
•    наличие описания входных и выходных данных;
•    наличие описания диагностических сообщений;
•    наличие описания характеристик ПО;
•    наличие описания оборудования, необходимого для функционирования ПО;
•    наличие описания программной среды функционирования ПО и др. используемых программ;
•    наличие оглавления;
•    соответствие оглавления содержанию документации;
•    грамматическая правильность изложения в документации;
•    отсутствие противоречий;
•    отсутствие неправильных ссылок;
•    ясность формулировок и описаний;
•    отсутствие неоднозначных формулировок и описаний;
•    правильность использования терминов;
•    краткость, отсутствие лишней детализации;
•    единство формулировок;
•    единство обозначений;
•    отсутствие ненужных повторений;
•    наличие нужных объяснений;
•    приемлемость стиля изложения;
•    ясность логической структуры;
•    наличие перекрестных ссылок;
•    наличие непрерывной нумерации страниц документов;
•    отсутствие незаконченных разделов, абзацев, предложений;
•    наличие всех рисунков, формул, таблиц;
•    наличие всех строк и примечаний;
•    логический порядок частей внутри главы.
Изменено: Orlan188 - 28.05.2013 23:08:50
Страницы: 1
Читают тему