Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentaton Is Extremely Murky and Unhelpful #211

Open
bakertaylor28 opened this issue May 20, 2023 · 1 comment
Open

Documentaton Is Extremely Murky and Unhelpful #211

bakertaylor28 opened this issue May 20, 2023 · 1 comment

Comments

@bakertaylor28
Copy link

PHP-Whois version:
4.1.10

PHP version:
8.2.6

Problem:
Documentation Is Extremely Murky and Unhelpful

Problem Description:
The Documentation is extremely murky and extremely unhelpful to those with little to no knowledge / experience with respect to writing code, or using an API. This often results in choosing to use another solution which is straight forward in the documentation and includes step by step examples to cover both correct installation and correct usage.

How to reproduce the problem:
Not Applicable. The problem is self-explanatory.

Possible Solution to the problem:
The developer should rewrite the documentation to supply step by step examples suitable for those
with little to no coding experience.
Developers need to remember that not everyone has the same level of experience with respect to coding, and open source projects need to be usable by everyone regardless of their experience.

Additional context of the problem
The context of this problem involves those persons whom are newer to programming in general and/or newer to the
PHP language. Developers should Always Remember that not everyone is as experienced as them, and should keep that
fact in mind when writing open source code and documentation, as to make their projects easily usable where the rubber
meets the road.

@io-developer
Copy link
Owner

Please submit the correct documentation in your opinion for public review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants