Start a new topic
Not Taken

Разработать качественную документацию на API

Документация на API сделана "чтобы было". 

Описания методов классов по одному предложению из которого не понятно, что вообще методы делают, примеров нет. Какие то жалкие примеры есть на сайте, но этого недостаточно. Ну и в добавок doxigen, чтобы помучаться пользователям. Поэтому приходится лезть постоянно в код (где это возможно) и смотреть, что отнимает кучу времени. 


Вот поднимался этот вопрос в чате поддержки https://t.me/tslabprorugroup/92849


Для уважающего себя программного продукта с платной подпиской качественная документация "is a must"!



2 people like this idea
1 Comment

Добрый день,


предложение должно содержать ключ "Как сделать".
В данном предложении его нет.
Как минимум, пользователи, которые разобрали одну или две темы по АПИ, могут выкладывать на сайт.
Через некоторое время может эти темы публиковать в документации.
Монетизация процесса на вашей стороне.
Все ссылки в публикации и авторство будут сохранены в документации.
http://forum.tslab.ru/ubb/ubbthreads.php?ubb=postlist&Board=93&page=1

Login to post a comment