Я аматорський розробник, і всі мої програми до цих пір були досить простими, щоб бути задокументованими в коді. Під час читання коду було зрозуміло, що я роблю таку і таку дію (мій стандартний тест полягав у тому, щоб подивитися на 6 місяців пізніше і зрозуміти все на першому прочитанні - і у мене короткий проміжок пам’яті).
Зараз я зіткнувся з програмою, яка переростає у мій потенціал на запам'ятовування різних взаємодій між ними
- сам код
- індекси в базі даних
- взаємодія між різними модулями (основний код «працівника» та «бібліотека»)
Моя поточна документація - це дошка, на якій я маю всілякі поля та стрілки, які вказують на код, на індекси бази даних, на дії, що виконуються, на зміну стану тощо. Просто для довідки, фрагмент безладу:
Моє запитання - чи існує стандартний чи названий набір найкращих практик (названий у сенсі, що це набір практик, які були згруповані під конкретною назвою) для документації більш складних продуктів.
Які ключові слова я повинен шукати (загальні спроби "стандартів архітектури програмного забезпечення документа" та подібні варіації, як правило, призводять до програмного забезпечення для робочих процесів або архітектури систем CAD архітектури).
Я також очікую, що не може бути загальних найкращих практик для описів на високому рівні і що кожен будує свою власну філософію.