по инсталляции:
1. Getting started: настойка окружения, билд, прошивка, поверхностная проверка работоспособности
2. Расширенные примеры использования (например, если прошивка у тебя содержит консоль в которой можно что-то поделать или требует дополнительной настройки).
3. Референс по опциям билда, запуску автоматизированных тестов, консоли, конфигураций и т.п.
4. Troubleshooting по запуску/конфигурации если надо
Дока по интеграции (если устройство предполагает наличия какого-то API или использует какой-то протокол):
0. Краткая выжимка по протоколам/API. Отвечает на вопрос "нафига оно тут?"
1. Базовые примеры использования, типа "что бы лампочка загорелась, отправьте пакет туда и туда".
2. Детальный референс (описание каждой команды и все такое)
3. Траблшутинг, если надо
Ну и проектная документация, если очень очень надо:
1. User story
2. Use cases
3. Requirements
4. System architecture
А я картинки процессов и состояний рисую.
Обсуждают сегодня