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
I love the product. However, the language in docs & product is sometimes awkward and/or contains grammar mistakes. While it does not affect understanding, I believe it is something that can be improved upon.
Some examples are:
It is not clear to me why three tenses are used here ("bookkeeping", "scan", & "detects")
Is "project" countable? The usage is not consistent between the first sentence and the second and third. Also, A "project" is not comparable with a "project concept".
I think the accumulation of details like these could affect how the product is overall perceived. Adding a dedicated writing style guide could be helpful (like the Apple Publications Style Guide).
The text was updated successfully, but these errors were encountered:
Thanks for raising this. The first problem is an unfortunate, we just updated the website.
Bytebase project is similar to the project concept in other common dev tools.
This was intended, another way to write is "The Bytebase project concept is similar to the project concept in other common dev tools." However, that is less terse.
Adding a dedicated writing style guide could be helpful (like the Apple Publications Style Guide).
We are always aspiring to great technical writing.
For Bytebase, we just started to build the technical writing guideline (we did include Apple's document as a primary reference. There is still a long way to go.
Please feel free to raise issues if you find more issues.
I love the product. However, the language in docs & product is sometimes awkward and/or contains grammar mistakes. While it does not affect understanding, I believe it is something that can be improved upon.
Some examples are:
I think the accumulation of details like these could affect how the product is overall perceived. Adding a dedicated writing style guide could be helpful (like the Apple Publications Style Guide).
The text was updated successfully, but these errors were encountered: