This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Структура документации проекта
Аннотация
Приводится рекомендованная структура комплектов документации для каждого проекта.
Цель: единый, понятный, поддерживаемый набор разделов, без лишней сложности.
1. Для пользователей
Документация, ориентированная на конечных пользователей (или клиентов) проекта.
1.1 Инструкции
Подробные шаг-за-шаг-руководства: как установить, настроить, начать работать с продуктом.
Например: «Регистрация», «Первый вход», «Создание кошелька» и т.д.
1.2 Туториалы
Обучающие материалы: примеры использования, кейсы, «быстрый старт», чтобы познакомить пользователя с возможностями, показать путь от нуля к результату. Например: «Стейкинг токенов».
1.3 База знаний
ЧаВо (FAQ), справочные статьи, глоссарий, — всё, что хорошо помогает для поддержки и самостоятельного решения проблем. Например: «Термины проекта».
1.4 Руководства
Более комплексные, сценарные инструкции для продвинутых пользователей и их глубокого погружения. Например: «Оптимальное использование функции X», «Организация рабочих процессов с помощью продукта».
2. Для разработчиков
Документация, ориентированная на внутреннюю команду разработки, архитектуры, DevOps и т.д.
2.1 Проектная документация
Общая «высокоуровневая» документация по проекту.
Например: «Концепция проекта»
2.2 Инженерная документация
Технические спецификации и аналитика.
Например: «Системная аналитика», «Архитектура».
2.3 Технологическая документация
Автоматически-формируемая документация по API (сбор происходит из комментариев в коде). Например: API-спецификации, зависимости, модули.
2.4 Операционная документация
Документация, связанная с эксплуатацией, сопровождением, DevOps/инфраструктурой.
Например: «DRP».