Профессия "Технический писатель", или "Рыцари клавиатуры" | страница 73
2. При написании руководства администратора вам потребуется значительно глубже вникать в само программное обеспечение (до уровня продвинутого администратора, а не простого пользователя — потребуется разобраться во всех тонкостях настройки, использования и, возможно, борьбы с возникающими ошибками), зато не потребуется осваиваться в предметной области, так как пользователь-администратор работает только с программой, его задачей является её настройка, а не выполнение с её помощью каких-либо задач. Разумеется, в идеале техпис при написании любой инструкции должен владеть материалом чуть ли не на уровне разработчика, но здесь мы говорим о необходимом минимуме знаний и соответствующей им сложности текстов, которые вы сможете создавать. Иными словами, здесь вам придётся гораздо (в разы!) тщательнее изучить описываемое ПО, но не потребуется знать предметную область. Бывают исключения, и на уровне администратора приходится описывать ещё и часть производственных процессов, в которых участвует ПО, но это уже считается более «продвинутой» документацией и подобные задачи встречаются достаточно редко. В общем случае это второй по сложности тип документации.
3. При составлении полного описания какого-либо продукта, которое не является в полном смысле слова руководством, вы должны целиком и полностью описать продукт, то есть его свойства, параметры, возможности и т. д. Если полное описание представляет собой комплект документации, а не один документ с соответствующим названием, то попутно сюда могут входить и оба приведённых выше руководства. Но в любом случае, документ, содержащий непосредственное описание программы там будет, и главное при его разработке — описать все аспекты функционирования программы, все задачи, которые она должна решать, все системные требования, а также полностью все её элементы. Это достаточно сложный текст — описывать продукт придётся крайне скрупулёзно, а знать его потребуется досконально со всех сторон.
4. При описании API / программного кода / структуры БД / элементной базы устройства вам гарантированно не потребуется знать ничего за пределами вашего продукта, но в нём вы должны разбираться не хуже разработчика — знать все фрагменты кода, названия таблиц БД и так далее. Соответственно, вам потребуются навыки программиста или электронщика — без них «миссия невыполнима». Эта документация относится к разряду наиболее сложной среди всех возможных задач технического писателя.