Разработка документации пользователя программного продукта. Методика и стиль изложения

книга практика для практиков, 01 октября 2008 г.

Арсентьев Дмитрий все отзывы

Говорят, что военные уставы написаны кровью.

Эта книга написана через пот и нервы действующим разработчиком технической документации с более чем 10-летним стажем работы.
Автор книги - выпускник 57-ой школы, кандидат филологических наук, успешно завершивший около сотни проектов по разработке документации, ещё 10 лет назад написал руководство по стилю (т.н. MetaGuide),
ставшее внутрикорпоративным стандартом в аутсорсиноговой компании, занимающейся разработкой технической документации.
Настоящая книга - переработанный вариант MetaGuide. По сравнению с первоначальным вариантом изложение стало суше и лаконичнее.

Вообще, книга почти что автоморфна: те рекомендации, которые даны в ней для написания документации, применены почти всюду и в самой книге. Лишь изредка автор позволяет себе отступить от строгого лекала, иронично допуская в текст двойное отрицание или стилистический оксюморон. Главным героем этой книги является русский язык, вернее, тот его диалект, который уместно назвать техническим канцеляритом.
Очень продуманное и тщательное изложение, внимательное отношение к языку, - всё это помогает осознать и преодолеть те трудности (в том числе и трудности выбора того или иного варианта изложения),
которые, как правило, преследуют добросовестного разработчика документации, съедают его время и силы.


Книга адресована прежде всего именно практикам. Только попробовав самостоятельно писать документацию, можно оценить истинный масштаб работы, проделанной автором. Автор намеренно сужает предмет обсуждения,
отсекая некоторые побочные ветви на богатом древе технического писательства. Например, на вопрос "Учебник или справочник?" автор даёт однозначный ответ: техническая документация - это справочник.

Эта книга - не детектив, её по-хорошему трудно читать. Труд, затраченный на её прочтение и усвоение изложенного материала, окупается многократно, о чём могу судить по собственному опыту чтения MetaGuide.

С заказчиком согласовано..., 08 июля 2011 г.

Лепилин Виктор все отзывы

Очень часто фраза "С заказчиком согласовано..." является краеугольной в проекте, где эксплуатационной документации отведена не последняя роль. Данная книга учит тому, как "подвести к единому знаменателю" стиль изложения, чтобы он устраивал всех участников проекта: заказчика, исполнителя и всех заинтересованных лиц.