Я же хуже народа, я пользователь документации, и с документацией в ворде, кажется, работал

Ну да, гугл индексирует лучше

Вот с 100 страниц распечатки точно работал

ну дык я вон дал пример сайта, который просто офигенно сделан. А теперь внимание, чОрный ящик.
Сдаём проект, где заказчик хочет гост и docx и требует описание всех методов именно в docx. Успехов вам создать docx, в котором API будет представлен так, что будет helpful

Не вижу ничего офигенного. Вижу, что на моем любимом 4:3 мониторе я от неё бы уже "сгорел" из-за разделения рабочих областей. Вижу, что при поиске мне надо раза три перевести взгляд (так что вместо внутреннего поиска я уже ушел использовать гугл). Вижу, что кнопка Home не работает при навигации. Вижу, что нет summary и список параметров запроса мне нужно скроллить, хотя я просто хотел узнать, как он называется и есть ли он.
Данная документация совершенно точно не является примером хорошо сделанной документации для постоянного рабочего инструмента, это документация для devops-а, который собирается 5 минут читать страницу перед одной операцией

вот можно мне вот эту портянку в одну строку в алфавитном порядке через запятую, пожалуйста?

я и так догадываюсь, что email имеет тип email или string и содержит email

если вы будете список полей объекта для апи писать в одну строку, вам придется очень долго и усиленно объяснять, зачем вы это делаете

это как раз пример стандартизации — все известные мне шаблоны документации апи сходятся на том, что поля надо разносить в список

для того, чтобы я одним взглядом мог вспомнить, как называется поле, или проверить, есть ли оно или нет

то, что вы догадываетесь, это здорово, но, поверьте, далеко не все столь прозорливы

Есть ли у customer поле last_modiifed или его аналог? Это мой вопрос к системе

Когда я писал статьи по всяким там efk и прочему на линуксе ,я писал языком, понятным пользователям.
И когда люди читали и делали по моим хелпам, то благодарили.
Потому что они не понимали тех статей, которые написаны по госту, стандарту и просто заумным языком.
Будьте проще и ваш саппорт скажет вам спасибо )))

Ну вот как разработчик за это я бы сказал только *facepalm*

нажмите ctrl-f и посмотрите

кто вообще читает документацию апи целиком, тем более референс по объектам?

Вот еще пример очень качественного подхода к своему продукту и документации
https://laravel.com/docs/6.x/http-tests

все поля должны быть задокументированы, но обычно не стоит задачи, чтобы про все поля кто-то единовременно читал

ctrl+f чего? modified? last modified?

нажал ctrl+f проверяйте