Комментарии 18
Сколько времени ушло на создание, внедрение и допилку системы?
Систему разработали давно, в начале нулевых. Старожилы говорят, что ведущие разработчики «за пару недель» (с) выкатили.
Допиливать приходилось по-мелочи. Кода не очень много, разобраться и расширить — реально.
Но поддерживать старый код — не очень приятное занятие. Сейчас переписываем морду к базе (упомянутую в топике CMS).
Допиливать приходилось по-мелочи. Кода не очень много, разобраться и расширить — реально.
Но поддерживать старый код — не очень приятное занятие. Сейчас переписываем морду к базе (упомянутую в топике CMS).
Выглядит впечатляюще. Я правильно понял, что топики лежат в одной таблице, независимо от того, что они описывают (класс, поле, метод)?
Я про это не рассказывал, но уточню.
В одной таблице в CMS показываются топики про один тип элементов. Например, только классы. Или только члены классов (поля, свойства, методы, события и т.д.).
В БД каждый тип элементов представлен несколькими связанными таблицами. Там структура сильно сложнее. Например, статус топика — это отдельная сущность, все статусы хранятся в отдельной таблице. Так же обстоит дело с историей правок.
В одной таблице в CMS показываются топики про один тип элементов. Например, только классы. Или только члены классов (поля, свойства, методы, события и т.д.).
В БД каждый тип элементов представлен несколькими связанными таблицами. Там структура сильно сложнее. Например, статус топика — это отдельная сущность, все статусы хранятся в отдельной таблице. Так же обстоит дело с историей правок.
А как Ваш синхронизатор работает с Delphi VCL компонентами?
1. Документация версионируется? Если «да» — как решается проблема изменения в младших версиях для старших?
2. Дока пишется только по исходникам или есть какие-то основополагающие документы?
3. В какие форматы выгружается документация?
2. Дока пишется только по исходникам или есть какие-то основополагающие документы?
3. В какие форматы выгружается документация?
1. Версионируется. На уровне БД. Для новой версии отсаживаем БД c соответствующим названием. Если надо поправить старую версию, техпис подключается к соответствующей БД, вносит там правки. Может тут же пнуть сборку и через несколько минут получить в нужном формате обновлённую доку.
2. Документацию техписатель пишет основываясь на
— личном опыте (кладёт новый контрол на формочку и разбирается в нём),
— на инфе от разработчиков
— на инфе из технического задания для конпонента или его фичи
— исходниках.
3. Публикуем онлайн (последняя версия), публикуем для скачивания PDF и CHM файлы, инсталляцию MSH-файлов (интегрируются в студийный HelpViewer) и XML-файлики, которые лежат рядом с DLL-ками и обеспечивают наличие подсказок в студийном Intellisence. Xml-файлики для IntelliSence поставляются вместе с самими DLL-ками, отдельно не публикуются.
2. Документацию техписатель пишет основываясь на
— личном опыте (кладёт новый контрол на формочку и разбирается в нём),
— на инфе от разработчиков
— на инфе из технического задания для конпонента или его фичи
— исходниках.
3. Публикуем онлайн (последняя версия), публикуем для скачивания PDF и CHM файлы, инсталляцию MSH-файлов (интегрируются в студийный HelpViewer) и XML-файлики, которые лежат рядом с DLL-ками и обеспечивают наличие подсказок в студийном Intellisence. Xml-файлики для IntelliSence поставляются вместе с самими DLL-ками, отдельно не публикуются.
1. Т.е. не выдается никакой информации о том, что в следующей версии(-ях) надо бы исправленный раздел поправить?
2. Есть какие-то ссылки из записи о топике документации к внешним документам или техпис просто помнит о том, что и где описано?
3. Понятно. Выгрузки сами делали?
2. Есть какие-то ссылки из записи о топике документации к внешним документам или техпис просто помнит о том, что и где описано?
3. Понятно. Выгрузки сами делали?
1. В обычном режиме мы работаем с текущей версией документации. Если надо поправить текст в прошлой версии (и наверняка в нынешней) — приходится копипастить этот текст в две базы.
2. Обычно техпис помнит о том, что ему надо сделать. Тут у каждого свой подход. Я себе карточки в трелло со всеми ссылками и копипастой с писем накидываю, а кто-то может себе наклейки на монитор цеплять, кому как больше нравится.
3. Сборка готового хелпа — самописная. Но вот PDF мы генерируем из CHM сторонним инструментом.
2. Обычно техпис помнит о том, что ему надо сделать. Тут у каждого свой подход. Я себе карточки в трелло со всеми ссылками и копипастой с писем накидываю, а кто-то может себе наклейки на монитор цеплять, кому как больше нравится.
3. Сборка готового хелпа — самописная. Но вот PDF мы генерируем из CHM сторонним инструментом.
А кто заполняет Example? Хранится ли он в CMS? Как техписатель узнает, что уже есть нужный Example.
Example (пример) пишет техписатель. Может написать по-новой или вытащить готовый из базы знаний.
Примеры тоже хранятся в БД, их там можно создать, удалить, отредактировать из CMS.
Примеры имеют осмысленные названия, можно воспользоваться поиском, чтобы найти нужный пример в базе знаний или в CMS.
Примеры тоже хранятся в БД, их там можно создать, удалить, отредактировать из CMS.
Примеры имеют осмысленные названия, можно воспользоваться поиском, чтобы найти нужный пример в базе знаний или в CMS.
промахнулся
Вот уж, что хреновое в devexpress так это документация! Отличный механизм чего уж там… Но сама документация отстой
Спасибо за отзыв.
Будем рады, если вы приведёте конкретные примеры того, где у нас сделано плохо. Если отсутствие какой-либо информации в документации не даёт вам сделать свою работу — напишите нам в техподдержку. Таким образом и вы свою проблему решите, и мы поймём где у нас есть потенциал для улучшения.
Если вам не нравится документация в целом, то приведите примеры хорошей документации
Будем рады, если вы приведёте конкретные примеры того, где у нас сделано плохо. Если отсутствие какой-либо информации в документации не даёт вам сделать свою работу — напишите нам в техподдержку. Таким образом и вы свою проблему решите, и мы поймём где у нас есть потенциал для улучшения.
Если вам не нравится документация в целом, то приведите примеры хорошей документации
Несколько запоздало, но скажу: абсолютно не согласен! Несколько лет плотно работал с .Net-компонентами DevExpress и документация у них просто замечательная! А в совокупности с техподдержкой вообще не имеет равных. Единственное, что могу отметить — часто документация не поспевает за развитием компонентов и остаются статьи, которые рекомендуют устаревшие подходы. Но это скорее показывает скорость развития продуктов, чем недоработки в процессе документирования.
И да, приходилось работать со многими другими платными библиотеками, так что есть с чем сравнивать.
И да, приходилось работать со многими другими платными библиотеками, так что есть с чем сравнивать.
Зарегистрируйтесь на Хабре, чтобы оставить комментарий
Ворочаем большими объёмами документации