Рекомендации по работе в модуле "Документация разработчика программного обеспечения"

Модуль «Докумендация разработчика» предназначен для создания и хранения документации разработчиков программного обеспечения. Он представлен категорией «Документация разработчика программного обеспечения (ПО)».

Мы собрали несколько рекомендаций, которые позволят вам эффективно использовать инструменты модуля:

Организуйте вашу документацию по папкам проектов, который будут связаны с соответствующими элементами «Проект» (категория «Проекты»). Это позволит поддерживать порядок в ведении документации и упростит её поиск.

Создавайте подробную документацию и связывайте с ней функциональные возможности (категория «Функциональные возможности ПО»). Благодаря этому вы сможете быстро перейти от программы или её отдельной функции ко всей необходимой документации.

Также рекомендуем связывать с документацией разработчика программное обеспечение (категория «Программное обеспечение») и тест-кейсы (категория «Тест-кейсы»). Таким образом вы сможете перейти ко всей необходимой документации от информационной модели программы или тест-кейса.

Используйте различные типы элементов для разграничения типов документации и упрощения её организации и поиска.