Files
knowledge/разное/idea/структура док.md
T

6.3 KiB

docs/
  00_project/
    project-overview.md
    team-and-responsibilities.md
    roadmap.md
    glossary.md

  01_mission/
    mission-statement.md
    stakeholders.md
    user-analysis.md
    use-cases.md
    concept-of-operations.md

  02_requirements/
    system-requirements.md
    software-requirements.md
    payload-requirements.md
    verification-matrix.md

  03_system-architecture/
    system-context.md
    system-decomposition.md
    modes-of-operation.md
    budgets.md
    risks.md

  04_interfaces/
    icd-overview.md
    icd-obc-eps.md
    icd-obc-radio.md
    icd-obc-payload.md
    telemetry-and-commands.md

  05_subsystems/
    structure/
      design.md
      calculations.md
      drawings.md
      mass-budget.md

    power/
      design.md
      electrical-schematics.md
      power-budget.md
      battery-analysis.md

    communication/
      design.md
      link-budget.md
      radio-protocol.md

    obc/
      hardware.md
      software-architecture.md
      algorithms.md

    payload/
      design.md
      data-processing.md

    ground-station/
      architecture.md
      user-interface.md
      operations.md

  06_software/
    architecture.md
    modules.md
    state-machine.md
    algorithms.md
    build-and-flash.md
    coding-guidelines.md
    tests.md

  07_verification/
    test-plan.md
    unit-tests.md
    integration-tests.md
    environmental-tests.md
    communication-tests.md
    results/

  08_decisions/
    edr-001-choose-obc.md
    edr-002-radio-band.md
    edr-003-power-architecture.md

  09_operations/
    operations-manual.md
    ground-commands.md
    telemetry-dictionary.md
    anomaly-handling.md

Минимальный набор документов для команды из 10 человек

Если сделать совсем практично, я бы начал с 10 документов.

Документ Зачем нужен
1 mission-statement.md Что за миссия и зачем спутник существует
2 concept-of-operations.md Как система будет использоваться
3 system-requirements.md Что система должна делать
4 system-architecture.md Из каких подсистем состоит
5 modes-of-operation.md Режимы работы спутника
6 icd-overview.md + отдельные ICD Интерфейсы между подсистемами
7 budgets.md Масса, энергия, канал связи, память, стоимость
8 software-architecture.md Архитектура бортового и наземного ПО
9 verification-matrix.md Как проверяются требования
10 engineering-decisions/ Почему приняты ключевые решения

Как распределить arc42, C4, SysML и системную документацию

Лучший вариант — не выбирать что-то одно, а разделить области применения.

Область Инструмент/шаблон
Общая миссия Mission Statement, ConOps
Пользователи и сценарии Use Cases, ConOps
Системные требования SyRS, таблица требований
Архитектура всей системы SysML-lite, block diagrams
Интерфейсы ICD
ПО arc42-lite или C4
Алгоритмы UML Activity / State Machine
Решения EDR/ADR
Расчёты Analysis Reports, budgets
Проверка V&V Matrix, test reports

Сравнение вариантов

Подход Для вашего CubeSat Сложность Что покрывает лучше всего
arc42 Частично Средняя Архитектура ПО
C4 Хорошо, но только для ПО/структуры Низкая Визуальное объяснение системы
4+1 Частично Средняя Runtime и physical view ПО
ISO 42010 Хорошо как философия Высокая Views/stakeholders/concerns
SysML / MBSE-lite Очень хорошо Средняя/высокая Система, интерфейсы, требования
NASA CubeSat 101 style Очень хорошо Средняя Жизненный цикл CubeSat
ICD Обязательно Средняя Интерфейсы
SRS/SyRS Обязательно Средняя Требования
V&V Matrix Очень желательно Средняя Проверка требований
ADR/EDR Обязательно Низкая История решений
Docs-as-Code Очень хорошо Низкая/средняя Совместная работа