Word и Excel в проектной документации
Зачем офисные программы в IT-проекте
Markdown в Git и wiki закрывают внутреннюю разработку, но заказчик, вуз и госсектор часто ждут DOCX и таблицы в XLSX. Word даёт структуру текста (заголовки, оглавление, колонтитулы); Excel — сортировку, фильтр и черновые расчёты по реестрам.
Теория элементов документа — в Архитектуре документации. Базовые навыки интерфейса — в 211 и 212. Здесь — how-to под типовые артефакты проекта.
Оглавление и нумерация в Word
ГОСТ-комплект и диплом требуют оглавления с номерами страниц. Ручная сборка ломается при каждой правке; автоматическое строится из стилей заголовков.
- Выделите название раздела и назначьте стиль «Заголовок 1», подразделам — «Заголовок 2», «Заголовок 3» («Главная → Стили»). Не форматируйте заголовки только жирным шрифтом.
- Установите курсор туда, где нужно оглавление (обычно после титульного листа).
- «Ссылки → Оглавление» — выберите автоматический вариант или «Настраиваемое оглавление» для уровней и точек-лидеров.
- После правок текста обновите оглавление — правый щелчок → «Обновить поле» (только номера или весь список).
Колонтитулы («Вставка → Верхний / Нижний колонтитул») — шифр документа, версия, номер страницы. Для титульного листа включите «Особый колонтитул для первой страницы», чтобы не дублировать номер на обложке.
.dotx — дальше только текст.Таблицы в Word для формальных документов
Таблица требований, матрица ролей или перечень API-методов в Word вставляется через «Вставка → Таблица»:
- Сетка — быстро задать число строк и столбцов.
- «Вставить таблицу» — точные размеры в диалоге.
- «Преобразовать текст в таблицу» — списки с разделителем (табуляция, точка с запятой) превращаются в таблицу за один шаг.
- «Таблица Excel» — встроенный фрагмент с формулами; уместен для небольших расчётов внутри ТЗ.
После вставки появляются вкладки «Конструктор» и «Макет» — объединение ячеек, повтор заголовка на новой странице, сортировка строк. Подробнее о приёмах — в 211.
Excel как реестр требований
Пока нет Jira или DOORS, аналитик часто ведёт реестр в Excel.
Рекомендуемые столбцы:
| Столбец | Пример |
|---|---|
| ID | REQ-001 |
| Формулировка | Система должна… |
| Приоритет | Must / Should |
| Источник | Протокол совещания |
| Статус | Черновик / Согласовано |
| Связь с тестом | TC-014 |
Практика:
- Первая строка — заголовки; данные с второй.
- Ctrl+T — оформить как таблицу Excel.
- Фильтр — показать только открытые или Must-have пункты (212 — фильтрация).
- Сортировка — по приоритету или статусу.
- Столбец ID не редактировать вручную после согласования — иначе ломается трассируемость к ПМИ.
Сложный анализ и сводные таблицы — в EDA в Excel. Экспорт реестра в Word — копирование диапазона или вставка связанной таблицы.
Рецензирование и защита Word
Согласование ТЗ и отчётов:
- Выделите фрагмент → «Рецензирование → Создать примечание».
- «Показать примечания» — панель обсуждения справа; при печати примечания можно скрыть.
- «Отслеживать изменения» — правки помечаются цветом и автором; принять или отклонить пакетом.
«Ограничить редактирование» («Рецензирование») — запрет правок или разрешение только комментариев. Пароль на документ — «Файл → Сведения → Защитить документ».
Диаграммы и отчёты для презентаций заказчику
Черновой график KPI или burn-down удобно собрать в Excel (212 — диаграммы), затем вставить в Word или PowerPoint. Перед совещанием проверьте подписи осей и единицы измерения — они часто «обрываются» при копировании.
Когда уходить из Word/Excel
| Ситуация | Лучший следующий шаг |
|---|---|
| Версионирование и ревью как у кода | Markdown в Git, Docusaurus — см. 1006 — экосистема |
| Живая трассируемость требований | Jira, Azure DevOps, специализированные RM |
| Большие данные и модели | SQL, Python, R — раздел анализа |
| Публикация API | OpenAPI |
Word и Excel остаются мостом к формальной сдаче; внутренняя правда продукта всё равно живёт в репозитории и трекере.
См. также
Другие статьи этого же раздела в боковом меню (как на странице "О разделе"). Техническое письмо - это когда мы объясняем сложную штуку (кнопки, код, болты, законы) так, чтобы другой человек понял её с первого раза и не накосячил. Документация — это совокупность документов, созданных для описания, объяснения, сопровождения или управления продуктом, системой, процессом или проектом. В мире существует очень, ОЧЕНЬ много видов документов. Вы даже себе не представляете, насколько. Технический писатель - специалист, занимающийся написанием технической документации. Хорошая документация — это та, которую не нужно объяснять устно. Если команда постоянно уточняет — А в документе это имеется в виду так-то? — значит, документация недостаточно ясна. Архитектура документации — это целенаправленное проектирование структуры, содержания, форматов, потоков и взаимосвязей всех документов, сопровождающих продукт или систему на всех этапах её жизненного. Markdown Extra — используется в некоторых генераторах (например, в MkDocs) для расширенных возможностей. Стилевой паттерн - это готовый шаблон того, как писать и оформлять код или текст. Техническое задание (ТЗ) — это документ, в котором заказчик и исполнитель договорились о правилах игры до того, как кто-то начал что-то делать. Спецификация - это список всех деталей и инструкций к ним, которые входят в поставку программы. Опись того, за что платят и что получают. ПМИ - это документ, в котором написано, как будут проверять, работает ли программа так, как надо. Если используется open-source компонент, указывайте название, версию, лицензию и источник.Техническое письмо
Документация
Виды документации
Технический писатель
Качество документации
Архитектура документации
Экосистема технического письма
Стилевые паттерны технической документации
Техническое задание по ГОСТ
Спецификация по ГОСТ
ПМИ по ГОСТ
ПЗ по ГОСТ