You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The overall documentation content is confusingly worded and hard to follow from a beginner's perspective.
Suggestions
Run your documentation through a grammar checker. While the content of the documentation is good, even great, the wording obfuscates just how good it is entirely.
This is a great example of what I'm talking about. The beginning documentation makes sense -- the method is important because it initializes the instance for use.
However, in the second sentence of the About section...
This method provides the option of omitting specifying
Can you expect anyone that isn't an English major to comprehend that the first time they read it? (I'm exaggerating, yes, but just to get the point across.)
I really like this documentation, but it needs to be easier to read. I completely understand that your repo is in its incubation phase (it's not even reached v0.1 yet -- this is incredible work so far), but documentation is one of your biggest selling points. If you want that to be upheld, you'll need to keep working on it.
The text was updated successfully, but these errors were encountered:
The Outdated/Incorrect Information
The overall documentation content is confusingly worded and hard to follow from a beginner's perspective.
Suggestions
Run your documentation through a grammar checker. While the content of the documentation is good, even great, the wording obfuscates just how good it is entirely.
This is a great example of what I'm talking about. The beginning documentation makes sense -- the method is important because it initializes the instance for use.
However, in the second sentence of the
About
section...This method provides the option of omitting specifying
Can you expect anyone that isn't an English major to comprehend that the first time they read it? (I'm exaggerating, yes, but just to get the point across.)
I really like this documentation, but it needs to be easier to read. I completely understand that your repo is in its incubation phase (it's not even reached
v0.1
yet -- this is incredible work so far), but documentation is one of your biggest selling points. If you want that to be upheld, you'll need to keep working on it.The text was updated successfully, but these errors were encountered: