Нужно покрыть документами весь код.
Документация должна быть в двух видах:
1) docstring-и ко всем методам и классам
2) Общая документация
Общая документация
В общей документации должно быть два раздела: 1) intro для нубов и 2) полноценное описание логики работы.
intro для нубов
Тут должно быть на пальцах объяснено и показано на картинках как работать с нашей системой. Всё должно быть максимально просто и кратко. Также нужно поместить сюда раздел с частыми ошибками и их решениями.
полноценное описание логики работы
Тут нужно аккуратно описать как работают наши микросервисы, описать взаимосвязи и тонкие места системы, о которых мы знаем.
Нужно покрыть документами весь код. Документация должна быть в двух видах: 1) docstring-и ко всем методам и классам 2) Общая документация
Общая документация В общей документации должно быть два раздела: 1) intro для нубов и 2) полноценное описание логики работы.
intro для нубов Тут должно быть на пальцах объяснено и показано на картинках как работать с нашей системой. Всё должно быть максимально просто и кратко. Также нужно поместить сюда раздел с частыми ошибками и их решениями.
полноценное описание логики работы Тут нужно аккуратно описать как работают наши микросервисы, описать взаимосвязи и тонкие места системы, о которых мы знаем.