API reference & community content

В пакет разработчика (SDK) версии 4.3 включена справочная документация в формате CHM, содержащая описания классов и методов объектной модели платформы:

• COMReference.chm - описание COM-интерфейсов (ObjectManager.dll и CardHost.dll)
• Reference.chm - описание .NET-интерфейсов (DocsVision.Platform.ObjectManager и DocsVision.Platfrom.WinForms.dll)

В ближайшее время будет также выпущена дополнительная справка WorkflowReference.chm, включающая в себя описания классов из сборок DocsVision.Workflow.Runtime (объектная модель ядра Workflow) и DocsVision.Workflow.Gates (объектные модели стандартных шлюзов).

Эти справочные руководства генерируются автоматически на основании скомпилированных сборок и комментариев к методам из исходного кода. Поэтому не следует искать там пути решения конкретных задач, примеры кода, советы, и .д. - для этой цели по прежнему служит отдельный документ - "Руководство разработчика на платформе DocsVision". Скорее, следует расценивать их как способ быстро посмотреть сигнатуру тех или иных методов; отследить взаимосвязи классов; уточнить значения перечислений; и т.д. В этом смысле, справочные руководства сейчас аналогичны по функциональности простому браузеру объектов (нажать F2 в Visual Basic 6, или Ctrl+Alt+J в Visual Studio 2005-2008)...

Но со временем мы рассчитываем дополнять данные справочные руководства, и расширять их теми самыми описаниыми, советами, примерами кода (аналогично http://msdn.microsoft.com/) - а документ "Руководство разработчика на платформе" упразднить.

Однако, это длительная и сложная работа (т.к. объем документации очень велик), и потому мы возлагаем надежды на помощь сообщества в этом деле. С этой целью, в справочные руководства включен так называемый community content - возможность всем читателям оставлять свои комментарии к статьям, задавать вопросы, писать ответы (примерно также, как это делается в блоге). С помощью данного инструмента станет возможным пополнение документации усилиями партнеров, обмен опытом между ними напрямую - без использования посредников в виде форумов или этого блога. И в конечном счете, выгодно это будет всем.

Функции community content включают в себя:

1) Возможность оставлять публичные (видимые всем), или личные (видимые только автору) заметки к любой статье, а также просматривать публичные комментарии других читателей:

2) Возможность фильтровать отображаемые комментарии:






3) Возможность оценивать полезность статей с помощью рейтинга:



Для написания комментариев, требуется минимальная регистрация (имя, пароль). Регистрация сквозная на всю документацию (не требуется отдельной регистрации на каждое руководство).

Все комментарии к документации будут модерироваться нами, с целью исключения спама и не относящихся к делу обсуждений.

Внимание! Данная услуга пока запущена нами в тестовом режиме, с целью изучения ее востребованности и актуальности. В связи с этим, возможны перебои в ее работе, или исчезновение оставленных комментариев. Просим отнестись к этому с понимаем. При высокой степени востребованности данной услуги, она будет развиваться и совершенствоваться.

Скачать последнюю версию DocsVision 4.3 SDK можно по ссылке: ftp://ftp.docsvision.com/DownloadArea/Temp/SDK1838.zip Читать дальше