Код как вики: гипертекстовое грамотное программирование

Грамотное программирование — классическая нишевая практика, получившая неожиданное мейнстримное проявление в виде Jupyter Notebook. Основная его идея — создание максимально читаемого человеком кода благодаря представлению программы в первую очередь как текста с, во вторую очередь, кодовыми вставками, которые объясняет окружающий текст.

Однако заметим, что в крупных программных проектах всё равно происходит разделение этих двух сущностей на собственно код проекта и на вики, которая:

• крайне полезна для новичков, чтобы разобраться в кодовой базе;
• также важна для опытных работников, чтобы быстрее вспоминать устройство кодовой базы;
• несмотря на всё вышеперечисленное, плохо поддерживается в актуальном виде.

Для решения данной проблемы предлагается довести идею грамотного программирования до логического завершения. В нашей интерпретации, кодовая база и вики проекта являют собой единую иерархическую сущность, разделённую на отдельные файлы, ссылающиеся друг на друга с помощью гиперссылок как во Всемирной сети.

Ожидаемые и неожиданные последствия:

• решение проблемы поддержки актуальности вики проекта;
• интеграция модульной системы в механизм гиперссылок;
• документируемость не только исходного кода, но и ассетов, а также файлов сборки проекта.

Принимаются как варианты реализации такой системы как для конкретных языков/систем сборки, так и агностичной к языку/платформе.

См. также: Грамотное программирование в Sanskrit