Звертаючись до RTOS, ми зазвичай маємо справу з додатком, у якого є багато паралельних завдань, які потрібно планувати оптимально, щоб кожен із них вчасно дотримувався своїх термінів або безпечно ділив ресурси. Рамка RTOS, яку ви обрали, реалізує планувальник завдань, а ваше завдання (як правило) полягає в тому, щоб написати ці окремі завдання з певним набором властивостей (період, пріоритет тощо), а потім передати їх планувальнику. Тож щодо документації я би підходив до ретельного документування кожного завдання.
Більшість вбудованих програмних засобів і, наскільки я знаю, більшість RTOS написані не об'єктно-орієнтованою мовою, і, отже, може не отримати користі від багатьох речей, орієнтованих, наприклад, на діаграми класів.
Однак, документуючи завдання RTOS, будь-яка діаграма, яка добре описує завдання, була б корисною. Я думаю, діаграма послідовностей для кожного завдання може бути дуже корисною для прикладу. Поряд з цим ви можете вказати його жорсткі вимоги, такі як його період / частота, пріоритет, будь-які спільні ресурси, які він може використовувати, вимоги щодо попереднього виходу тощо. Також цінністю може бути документація того, як ви налаштували RTOS і, можливо, стан, машина алгоритму його планування.
Візьміть будь-яку з цих порад, як вам подобається, я не спілкувався з речами RTOS ще з моїх днів в коледжі, і ніколи не "документував" роботу.