WEGA-project/wega-hpg

Упрощение документации по формулам и доступность для разработчиков

Opened this issue · 0 comments

В текущем состоянии документация по формулам в нашем проекте представляет собой проблему для разработчиков. Мы хотели бы обратить внимание на необходимость упрощения и повышения доступности этой документации для всех пользователей проекта.

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

Мы предлагаем экспортировать документацию в один из широко используемых форматов, таких как RTF, PDF, HTML или любой другой доступный для чтения без установки дополнительного программного обеспечения. Это позволит разработчикам читать и изучать документацию прямо в интерфейсе GitHub, минуя необходимость скачивания дополнительных файлов.

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

Мы призываем команду по разработке документации принять во внимание эту проблему и рассмотреть возможность экспорта документации в форматы, доступные для чтения без установки дополнительного ПО. Это позволит нам улучшить работу с формулами и повысить эффективность процесса разработки.

Спасибо за внимание к этому вопросу. Мы верим, что упрощение и повышение доступности документации принесет значительные выгоды всем пользователям проекта и способствует его дальнейшему развитию.