Предлагаю в этой теме обсудить то, как можно оценить качество технической документации. Какие существуют методики и приемы.
Качество технической документации. Методы оценки
Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на почту!
@twriters 
чат для технических писателей в Telegram
Качество технической документации. Методы оценки
|
writer
 Администратор
Сообщений:
Баллов: 2410
Рейтинг:
3
Авторитет:
3
Регистрация: 03.04.2007
|
08.10.2012 13:24:54
|
|
|
|
|
09.10.2012 09:39:13
Методика оценки качества программной документации. Отчет по НИР (ротапринт). — М.: РосКЦИТО, 1996г, 61 стр.
|
|
|
|
|
|
writer
Администратор
Сообщений:
Баллов: 2410
Рейтинг:
3
Авторитет:
3
Регистрация: 03.04.2007
|
12.10.2012 16:53:39
 ссылки в личной переписке можно отправлять |
||
|
|
|
|
puhata
 Эксперт
Сообщений:
Баллов: 271
Рейтинг:
3
Авторитет:
3
Регистрация: 09.05.2007
|
15.10.2012 17:46:15
Если по ГОСТу , то можно использовать Р ИСО/МЭК 15910-2002
[i:2xucscmj] Настоящий стандарт содержит полный аутентичный текст международного стандарта ИСО/МЭК 15910-99 «Информационная технология. Процесс создания документации пользователя программного средства»[/i:2xucscmj] там достаточно подробно описано как разрабатывать документ, так и как его принимать. рекомендую. |
|
|
|
|
18.10.2012 11:38:49
 Что-то знакомое |
|||
|
|
|
|
Orlan188
 Эксперт
Сообщений:
Баллов: 255
Рейтинг:
0
Авторитет:
7
Регистрация: 28.05.2013
|
28.05.2013 23:08:17
Всем привет!!!Если оценивать в баллах, то каким будет проходной? - относительно документации... Кстати в одном древнем документе, который был выловлен мной в сети интернет (документ описывал работу какого-то ПО РЖД), были выделены следующие критерии: Обобщенные требования к документации К документации предъявляются следующие требования: • полнота и понятность документации; • достаточность документации для ввода ПО в эксплуатацию; • правильность документации; • приемлемость уровня технического исполнения документации; • наличие краткой аннотации ПО; • наличие описания решаемых задач; • наличие описания ограничений по применению; • наличие описания структуры функций ПО; • наличие описания функций ПО; • наличие описания алгоритмов; • наличие описания пользовательских интерфейсов; • наличие описания входных и выходных данных; • наличие описания диагностических сообщений; • наличие описания характеристик ПО; • наличие описания оборудования, необходимого для функционирования ПО; • наличие описания программной среды функционирования ПО и др. используемых программ; • наличие оглавления; • соответствие оглавления содержанию документации; • грамматическая правильность изложения в документации; • отсутствие противоречий; • отсутствие неправильных ссылок; • ясность формулировок и описаний; • отсутствие неоднозначных формулировок и описаний; • правильность использования терминов; • краткость, отсутствие лишней детализации; • единство формулировок; • единство обозначений; • отсутствие ненужных повторений; • наличие нужных объяснений; • приемлемость стиля изложения; • ясность логической структуры; • наличие перекрестных ссылок; • наличие непрерывной нумерации страниц документов; • отсутствие незаконченных разделов, абзацев, предложений; • наличие всех рисунков, формул, таблиц; • наличие всех строк и примечаний; • логический порядок частей внутри главы.
Изменено: Orlan188 - 28.05.2013 23:08:50
|
|||
|
|
|
|||
Читают тему