Волков С. М.15.08.2024
Документация получилась исчерпывающей, хорошо структурированной и с интуитивно понятной навигацией. Особенно порадовали четкие инструкции по развертыванию системы и troubleshooting-гайды. Это значительно ускорило процесс внедрения ПО в открываемых филиалах и снизило нагрузку на администраторов головного офиса. 
Новости и статьи
Инструменты для генерирования документации из кода
Существуют инструменты, позволяющие собирать комментарии к коду, а на основе их создавать документацию. Какие они бывают и в чем их особенность? Подробнее
Существуют инструменты, позволяющие собирать комментарии к коду, а на основе их создавать документацию. Какие они бывают и в чем их особенность? Подробнее
Разработка прототипов (интерфейса) программного обеспечения
Как будет выглядеть интерфейс продукта? Какие в нем будут структурные элементы? Подобные вопросы возникают у заказчика на первых этапах разработки программного обеспечения. Ответить на них разработчик может при помощи прототипов. Подробнее
Как будет выглядеть интерфейс продукта? Какие в нем будут структурные элементы? Подобные вопросы возникают у заказчика на первых этапах разработки программного обеспечения. Ответить на них разработчик может при помощи прототипов. Подробнее
Документация как код (Docs as Code)
Как правило, документация не особо интересна разработчикам, но без их помощи документ может быть неточным, неполным и непонятным. Как привлечь разработчика к созданию документа? Подробнее
Как правило, документация не особо интересна разработчикам, но без их помощи документ может быть неточным, неполным и непонятным. Как привлечь разработчика к созданию документа? Подробнее
В чём разрабатывать программную документацию?
Существует множество подходов для создания документов. В первую очередь при выборе инструмента необходимо ответить на ряд вопросов.
Подробнее
Программная документация в GitBook
Одновременно в подготовке документа могут быть задействованы технические писатели, разработчики, аналитики, тестировщики и руководители проекта. Каждый специалист стремится внести свою лепту в процесс создания документа. Для гармоничной совместной работы создана платформа, позволяющая вносить изменения в документацию с сохранением предыдущих версий – GitBook. Подробнее
Одновременно в подготовке документа могут быть задействованы технические писатели, разработчики, аналитики, тестировщики и руководители проекта. Каждый специалист стремится внести свою лепту в процесс создания документа. Для гармоничной совместной работы создана платформа, позволяющая вносить изменения в документацию с сохранением предыдущих версий – GitBook. Подробнее
Использование Markdown при разработке программной документации
Markdown – облегченный язык текстовой разметки. С чем связано появления данного языка? В 2000-е гг. удобных платформ для размещения контента не было: для публикации отформатированного текста приходилось обращаться к HTML разметке. Основным минусом этого языка была необходимость вручную прописывать большое количество тегов. Это затрудняло процесс написания и исправления текста.
Подробнее
Wiki-системы и их особенности применения для программной документации
Wiki-системы можно разделить на публичные, корпоративные и частные. Доступ к просмотру и редактированию информации, размещенной в публичных системах, имеет любой пользователь сети. Частные системы позволяют создавать персональные базы знаний. Доступ к таким системам ограничен одним пользователем... Подробнее
Wiki-системы можно разделить на публичные, корпоративные и частные. Доступ к просмотру и редактированию информации, размещенной в публичных системах, имеет любой пользователь сети. Частные системы позволяют создавать персональные базы знаний. Доступ к таким системам ограничен одним пользователем... Подробнее
Программная документация в Confluence
Система Confluence – результат деятельности австралийской компании Atlassian, создающей ПО для управления разработкой ПО. Известность компании принесли два продукта: Jira и Confluence. Первый продукт обеспечивает управление проектами на любой стадии разработки, а второй – нацелен на обмен специалистами важной информацией по проекту. Подробнее
Система Confluence – результат деятельности австралийской компании Atlassian, создающей ПО для управления разработкой ПО. Известность компании принесли два продукта: Jira и Confluence. Первый продукт обеспечивает управление проектами на любой стадии разработки, а второй – нацелен на обмен специалистами важной информацией по проекту. Подробнее
Виды программной документации
Программная документация: какая она бывает и для чего необходима? Расскажем в нашей статье, посвященной видам программной документации. Подробнее
Программная документация: какая она бывает и для чего необходима? Расскажем в нашей статье, посвященной видам программной документации. Подробнее
Новости и статьи нашей компании
Раздел предназначен для публикации полезной информации и информирования наших клиентов о новостях компании и интересных событиях в сфере разработки документации, ИТ-индустрии и др.
