читает в здравом уме, когда есть IDE? - а про мануал с примерами кода. Ну как, вот надо тебе новую либу подключить, какой первый шаг? Открыть мануал, скорпировать пример, запустить. Насколько хорошо примеры покрывают функционал? Сколько в них ошибок? Если ошибки есть, насколько они мешают быстро начать пользоваться библиотекой?
ну доки публичных проектов так или иначе генерируются из чего-то — кто-то пишет мануалы прямо в коде и генерит документацию (не помню проектов), а кто-то юзает markdown/restructured text. А вот эти вопросы — это наверное проблема 99% доков, потому что автоматизировать такое сложно
Обсуждают сегодня