Комментарии 14
Блин, во время моего обучения такого не было. Была только книга автора и не полностью документированная sdk.
А вот для студента как раз такое изложение самое то, чтобы замотивировать.
А рассматривали вариант описания API на примере какого цельного проекта, где разные этапы реализации затрагивали разные аспекты API?
Автору за статью огромное спасибо! Жду продолжения.
PS
Когда был курсовой (где-то 2012 год) по написанию модуля для какой-то (на выбор) САПР, выбрали не КОМПАС, по причине слабой документации к API.
2.5 года назад я тоже не нашел толковой документации, а по всем вопросам предлагалось обратиться то ли на форум, то ли в группу в ВК. И такая "открытость" как я понял распространённая практика среди российских компаний.
И такая "открытость" как я понял распространённая практика среди российских компаний
Соглашусь. И чуток добавлю.
Про работу с ПО других компаний, могу сказать что российские вендоры организовывали обучение по API распространяемым систем.
Кстати насколько мне известно, некоторые из ребят которые проходили такое обучение, были задействованы в разработке CAE системы, очень хорошего качества.
Но создается впечатление что "открытость" документации — это не сильно нужно разработчикам, так как количество людей, которые пишут внешние модули к CAD очень мало. Плюс причесать к нормальному виду API — это наверное проще будет написать "с нуля".
Ну и зачем отнимать хлеб у себя же, если на такой поддержке можно заработать. Это можно аргументировать закостенелостью бизнес-процессов или отсутствием развития бизнеса в этом направлении, но я не сильно сведущий в области ведения бизнеса по продаже и продвижению САПР всякого рода. Хотя как маркетинговый ход, я думаю это было бы классно.
А насчет популяризации, было бы классно видеть перед глазами структурную схему API, что к чему относиться и от чего зависит. Не знаю, есть ли сейчас такая вещь, но раньше ее не было. Встречался с такой штукой только у одного продукта, и то ее вроде потом закрыли или перестали поддерживать.
Ну и зачем отнимать хлеб у себя же, если на такой поддержке можно заработать.
Да нет, мы не ставим цели заработать на поддержке. Нам как раз выгоднее, чтобы под КОМПАС писали больше сторонних приложений.
А насчет популяризации, было бы классно видеть перед глазами структурную схему API, что к чему относиться и от чего зависит. Не знаю, есть ли сейчас такая вещь, но раньше ее не было.
В каком формате это должно быть?
В каком формате это должно быть?
Да хотя бы тот же самый UML. С описание классов, например IDrawing — это за чертежку отвечает, реализует вот такие-то вещи. От него наследуются такие-то классы.
Студентам не имеющих опыта в разработке порой тяжело понять это все по коду или через вызов методов в IDE.
Ну или сделать статью с общим описание API с иллюстрациями.
Закинул в обсуждения в ВК:
vk.com/topic-29994774_26653498?post=65042
Если не получится скачать — выложу ещё куда-нибудь.
Шикарная штука! Вот такого мне в студенческие годы не хватало.
Вынесите такую штуку на сайте, и за одно еще в PNG сконвертируйте с хорошим разрешение.
Да нет, мы не ставим цели заработать на поддержке. Нам как раз выгоднее, чтобы под КОМПАС писали больше сторонних приложений.
ИМХО разослали бы по базе подписчиков/клиентской базе/CRM. Что у вас там, вам виднее. Популяризируйте свой API, делайте его более доступным и документированным. И будет вам счастье)
Кстати, что касается самой схемы, есть возможность описать методы у интерфейсов? Если это API, я как разработчик, хотел бы посмотреть что ваша система умеет, не заходя в сам SDK. Вот пример
И может вам подумать на системой к своему проекту, которая будет сама генерить документацию на API. В мире что-то типа javadoc в мире Java. Или какой-то скрипт натравить на исходную базу, чтобы сформировала описание, хотя бы без детального описания.
Плюс, если вы запилите сайт со схемой SDK и ссылочками на раздел онлайн документации — это будет просто БОМБА!
ИМХО разослали бы по базе подписчиков/клиентской базе/CRM. Что у вас там, вам виднее. Популяризируйте свой API, делайте его более доступным и документированным. И будет вам счастье)
Для начала её актуализировать нужно. Её убрали из состава SDK, когда справка винды перестала поддерживать майнд-карты. А рядом почему-то не положили…
Плюс, если вы запилите сайт со схемой SDK и ссылочками на раздел онлайн документации — это будет просто БОМБА!
Появится возможность — сделаем.
по всем вопросам предлагалось обратиться то ли на форум, то ли в группу в ВК.
На нашем форуме кстати довольно активный раздел, посвященный использованию API: forum.ascon.ru/index.php/board,4.0.html
такая «открытость» как я понял распространённая практика среди российских компаний.
У нас просто нет людей, которые бы могли написать достаточное количество документации. Это довольно сложно найти человека, умеющего хорошо программировать и умеющего грамотно и понятно всё описывать.
А рассматривали вариант описания API на примере какого цельного проекта, где разные этапы реализации затрагивали разные аспекты API?
Идея хорошая, вопрос будут ли на это ресурсы. Всё что касается API могут писать только программисты, и для нас всегда очень серьёзный вопрос — посадить программиста писать что-то касающееся API или документации по нему или посадить его на написание нового кода. Пока мы можем себе позволить только привлечение сторонних авторов, как в данном случае Сергея.
Ну тут тогда вопрос о финансировании такого процесса. Может есть смысл отдавать что-то на фриланс или создавать заказы. Мол за документирование с примерами мы готовы заплатить N-ю сумму денег, кто готов?
Как вариант, студенты (Брянский Государственный Технический Университет) должны были разбираться с документацией (хотя бы минимально) в рамках курсовых проектов, а если за это им будут доплачивать, я думаю желающих будет больше.
Я в студенческие годы писал на Delphi расчет редуктора, и под КОМПАС тоже. Если бы меня деньгами простимулировали, я думаю было бы законченный продукт уже.
Работа с API КОМПАС-3D → Урок 4 → Основная надпись