Comments 10
gladkovs Я прочёл все три статьи, которые Вы разместили в этой серии. Заглянул сюда, поскольку документирование содержания БД — одна из наиважнейших задач при разработки. Надеялся увидеть не только набор select (с неоспоримо важным набором информации), но и как эти функции помогут мне в решении задачи помощи в создания набора документации. Кроме кода в картинках и простыней текста в конце статьи ответов не нашел.
В данном случае, мне не очень нужны Ваши извинения. Это предложение написать нулевую статью к данной серии (даже постфактум), где описать высокоуровневое применение Ваших текстов. В случае с комментарием про картинки — заменить картинки текстом, даже если Вам не нравится форматирование или цветовая схема. Возможно, выложить в репозиторий, чтобы не нужно было проматывать простыню кода, чтобы понять, будет ли что-то ниже.
Так же хочу отметить, что Ваши статьи будут иметь большее значение, если каждый сниппет кода, который Вы привели в картинках будет текстом. Каждый сниппет решает свою задачу, и, даже если это будет просто библиотека хранимых процедур, без явного отделения одного от другого они бесполезны.
Например, если текст хранимых процедур будет выложен в публичный репозиторий, а в каждом сниппете будет приводиться не только сам код, но и к какой функции он относится в Вашем репозитории, то на выходе получится отличная переиспользуемая библиотека с документацией.
Замечательно, но
- Большой текст кода в статье не является переиспользуемым, даже если Вы оформили его в виде хранимых процедур. Код в публичном репозитории — является: я могу, скорее всего, отправить замечания/комментарии/дополнения к коду, улучшив его, к коду из статьи — маловероятно.
- Большой текст кода, размазанный к множеству статьей — еще менее переиспользуем, учитывая правило 10 дней на данной блоговой платформе.
- Даже если код в картинке явлется центральной частью, то я, скорее всего, сначала его запущу отдельно, скопировав и запустив из статьи отдельный сниппет, и вернусь после к тому же месту, что и было ранее.
В случае с картинкой и хранимкой, мало того, что я должен:
- найти эту процедуру
- иметь право создавать процедуры
- удостовериться, что процедура делает то, что должна и не сломает мою бд и не уничтожит данные (безопасность — еще важный один фактор)
- разбираться с API процедуры (когда мне просто нужно заменить пару строк для моей базы)
- вернуться к контексту в статье (то есть скроллить с низу до верху, а первые пункты явно сломают этот конекст)
- Либо просто перепечатать простыню текста запроса, что, опять же, не доставляет удовольствия читателю Вашей статьи.
Функции для документирования баз данных PostgreSQL. Часть третья