Введение

1. Общие принципы составления технической документации к программному продукту

1.1. Техническая документация и ее состав

1.2. Цели и задачи технической документации

1.3. Язык как арсенал средств коммуникации

2. Общая логика изложения

3. Проблемы рационального размещения информации

3.1. Линейность текста. Принцип экономии усилий пользователя

3.2. Структура документации

3.2.1. Структурирование информации. Многоуровневая рубрикация

3.2.2. Стандартная структура документации как инструмент структурирования информации

3.2.3. Заголовки разделов и общие принципы их составления

3.3. Дублирование информации

3.4. Выделенные сведения и их графическое оформление

4. Проблемы стиля технической документации

4.1. Стилистическая культура и ресурсы языка

4.2. Лексические ресурсы языка

4.2.1. Предметно-понятийная лексика

4.2.2. Лексика действий и отношений

4.2.2.1. Общие замечания

4.2.2.2. Средства выражения действий и отношений: Глагол

4.2.2.3. Средства выражения действий и отношений: Прилагательные, причастия, деепричастия

4.2.2.4. Средства выражения действий и отношений: Существительное

4.2.2.5. Лексические средства выражения действий и отношений (обзор)

4.2.3. Основные лексические трудности

4.3. Синтаксис документации и его возможности

4.3.1. Общие замечания

4.3.2. Формализация изложения, ее возможности и аспекты

4.3.2.1. Значение формализации изложения

4.3.2.2. Унификация языка

4.3.2.3. Стандартные и специфические клише

4.3.3. Порядок слов

4.3.4. Ритмическая организация речи и ее значение

4.3.5. Неоптимальные конструкции и борьба с ними

4.4. Отношения с пользователем и стилистическая культура

5. Наиболее характерные ошибки и недочеты

5.1. Фактические ошибки и недочеты

5.2. Логико-стилистические ошибки и недочеты

5.3. Стилистические ошибки и недочеты