Y
Y
Yan Alexandrov2018-07-02 00:17:36
Documentation
Yan Alexandrov, 2018-07-02 00:17:36

What should be the ideal php application documentation?

What should the main page of the documentation include so that it is as structured as possible, easy to find the necessary information, so that you can immediately understand what, where, and how? And just convenient in terms of usability.
Please provide links to really high-quality documentation.

Answer the question

In order to leave comments, you need to log in

2 answer(s)
E
Evgeny Romashkan, 2018-07-02
@EvgeniiR

What I personally may not have enough in the documentation (besides the quality of the information) is a good, high-quality search.
https://vuejs.org/v2/guide/ - liked the documentation. Excellent search, easy to share links to the desired section and anchor on the page.
It's very cool when the documentation has at least a basic use case that you can immediately try out for yourself. Well, if this is some kind of global project - the sequence of presentation of information.
Regarding PHP - the documentation of modern frameworks like https://laravel.com/docs/5.6 are, in my opinion, quite high-quality examples.

E
Edward Tibet, 2018-07-13
@eduardtibet

What should the main page of the documentation include so that it is as structured as possible, easy to find the necessary information, so that you can immediately understand what, where, and how? And just convenient in terms of usability.
Please provide links to really high-quality documentation.

Again I do not see the main thing - the goal? What are your goals? Why does everyone ask questions How? without defining the original Why?
Depending on the target audience, the goals are different. Therefore, specify the parameters, what do you want to get as a result? Let's say I want developer A to find the right answer in X time. Or I want a person to immediately see that we have a cool product and want to buy it (order a service using it).

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question