Какой должна быть идеальная документация php приложения?

Question

[Ян Александров]

Что должна включать в себя главная страница документации, чтобы она была максимально структурированная, легка для поиска нужной информации, чтобы слету понимать, что, где, и как? И просто удобна с точки зрения юзабилити.
Накидайте пожалуйста ссылок на реально качественную документацию.

Answer 1

[Евгений Ромашкан]

То чего мне лично может не хватить в документации(помимо качества информации) - хороший, качественный поиск.
https://vuejs.org/v2/guide/ - понравилась документация. Отличный поиск, легко делиться ссылками на нужный раздел и якорь на странице.
Очень круто, когда в документации есть хотя бы базовый пример использования, который можно сразу опробовать у себя. Ну и если это какой-то глобальный проект - последовательность изложения информации.
Касательно PHP - документации современных фреймворков типа https://laravel.com/docs/5.6 представляют на мой взгляд вполне качественные примеры.

Comments

[Ян Александров]

Спасибо за ссылки

Answer 2

[Эдуард Тибет]

Что должна включать в себя главная страница документации, чтобы она была максимально структурированная, легка для поиска нужной информации, чтобы слету понимать, что, где, и как? И просто удобна с точки зрения юзабилити.
Накидайте пожалуйста ссылок на реально качественную документацию.

Опять не вижу главного - цели? Какие у вас цели? Почему все задают вопросы Как? не определяя изначального Зачем?

чтобы слету понимать, что, где, и как

В зависимости от ЦА - цели разные. Поэтому уточните параметры, что вы хотите получить в итоге? Допустим, я хочу, чтобы разработчик А находил нужный ответ за время X. Или я хочу, чтобы человек сразу увидел, что у нас крутой продукт и захотел его купить (заказать сервис с его использованием).