Здесь я пишу свои идеи, мысли, описываю события своей жизни и просто делаю личные и рабочие заметки. «А Вы что, собираетесь жить вечно?»

Документирование ПО

Довольно часто при написании дипломов по программному обеспечению, я сталкиваюсь с рутинным занятием — написанием документации.
Как правило, документация довольно детально и подробно должна описывать функции, меню, выполняемые операции и алгоритмы работы. А особо узкие места, сложные для понимания должны описываться более детально.
Но вот недавно пришлось мне поработать с одной системой управления сайтом HOST CMS, сказать честно, ребята которые пишут документацию и ставят описание к элементам, ушлёпки. Как правило описание элемента в точности соответствует его названию. И всё бы ничего, я бы не был так возмущён, если бы это не был коммерческий продукт. Мои работы и те получается документированы лучше.
Ребята, ёб вашу мать, пы продаёте это ГАВНО! Будьте любезны, доводиде дело до конца. Зачастую бесплатные проекты, которые пишутся одним человеком, выполнены значительно лучше.
Чтобы не быть пустозвоном, вот несколько скринов:

Ссылка, да не может быть! Невероятно! Ёба мать, а то я сам не понял Капитан очевидность нервно курит в сторонке

Если вдруг у вас возникла мысль, что можно скачать документацию, то спешу вас обрадовать, там описание не многим лучше. Особенно это касается документации программиста. Очень забавно выяснять, что за поле такое «Функция» и что туда вписывать, а главное, где эту функцию описать.

P.S. В моём представлении, система CMS для того и создаётся, чтобы максимально упростить управление сайтом. Т. е. сделана для людей с минимальными знаниями программирования, а на деле выходит, что купив коммерческий продукт, мы должны быть и программистами, и менеджерами, и дизайнерам и если надо сантехниками, мать их. Учитесь писать нормальную документацию, блеать!

Отправить
Поделиться
Запинить