WikiMedia для клиентов платформы
Актуальные сведения по возможностям интеллектуальной low-code платформы GreenData для создания бизнес-приложений, информационных систем и оптимизации бизнес-процессов любой сложности.
Документация по модулям
Создавайте сложные объектные модели без программирования |
Автоматизируйте бизнес-процессы любой сложности |
Формируйте электронные и печатные документы совместно |
Индивидуализируйте экранные формы в режиме Drag&Drop |
Задавайте бизнес-логику при любом действии и на любом этапе |
Используйте табличные и OLAP- отчеты, виджеты, дашборды |
Интегрируйтесь с внешними системами и сервисами |
Производите многоэтапные и пакетные расчеты |
Организуйте работу на мобильных устройствах |
Техническая документация
При создании программы, одного лишь кода, как правило, недостаточно. Должен быть предоставлен некоторый текст, описывающий различные аспекты того, что именно делает код. Такая документация часто включается непосредственно в исходный код или предоставляется вместе с ним.
Подобная документация имеет сильно выраженный технический характер и в основном используется для определения и описания API, структур данных и алгоритмов.
Часто при составлении технической документации используются автоматизированные средства — генераторы документации, такие как Doxygen, javadoc, NDoc и другие. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML.
Использование генераторов документации и документирующих комментариев многими программистами признаётся удобным средством, по различным причинам. В частности, при таком подходе документация является частью исходного кода, и одни и те же инструменты могут использоваться для сборки программы и одновременной сборки документации к ней. Это также упрощает поддержку документации в актуальном состоянии.
Дополнительная документация
-
Архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО.
-
Пользовательская — руководства для конечных пользователей, администраторов системы и другого персонала.
-
Маркетинговая — наборы материалов, позволяющие подогреть интерес к продукту у потенциальных пользователей, информировать их о том, что именно делает продукт, объяснить положение продукта по сравнению с конкурирующими решениями.