Самая тяжелая задача для программиста — написать отдельную документацию. Отдельную, то есть не комментарии и не документацию на методы. Например, мануал по инсталляции или — самое страшное — описание архитектуры.
Подсказываю чит, как легко и просто написать документацию.
Шаг 1: выпиши тезисы. Понятные только тебе. В любом порядке, как угодно, просто выгрузи все единицы знания из головы.
нужен докер но можно ставить и на хост image называется golubinaya ProductImage это на самом деле скрипт нода не меньше 13.x нужен компилятор для сборки обязательно тестируй через test/ ImageMagick используем через exec только убунта, остальные пофиг
Шаг 2: отсортируй по важности или по логике.
только убунта, остальные пофиг нужен докер image называется golubinaya но можно ставить и на хост нода не меньше 13.x нужен компилятор для сборки ImageMagick используем через exec ProductImage это на самом деле скрипт обязательно тестируй через test/
Шаг 3: замени каждый тезис на текст.
Only the stock Ubuntu 18.04 has been tested and is officially supported. Although there are no reasons why it won't run on other Linux flavours we just didn't check it so YMMV.
Please note that ProductImage is not a real executable but rather a shell script. So we don't run binary code in production.
Make sure your installation is indeed correct by running the test suite in test/ folder.
Ты понял секрет? Каждый шаг легко выполним, и в нем нет ничего сложного. Нечего бояться. Все просто.