Documents <Content, Editing, Flow, and Readability>

To Whom It May Concern:

Problem Description

I have read through much of the documentation text. Often, I am drawn to common grammatical errors, and other text which is unclear. As well as some suggested changes which do not actually fix the existing text and often contain the same problems as the original text.

Possible Solutions

Freeze the current document version, and let a Technical Writer go through the documents. Also give the Technical Writer the task of first outlining the various concerns or problems within the text; then, prescribe a way forward to correct the problems and present a uniform document set which those who know code and review.
it is clear, none native English speakers are making edits.

Complementary information

As one example of problems found in the documents, the following screen shot shows a bullet list found in the Configuration Guide. In this you will see that the first words of each bullet item are lower cased. In other guides, they are upper case.

Also, see my comments in (https://github.com/TheHive-Project/TheHiveDocs/commit/e3be895f5270ecc8e38910727db35f6eb928e767) TheHive4/ READMe.md (proof-reading & new section for webhook info.)

My recommendation is to engage a Technical Writer like myself with the experience to help you.

v\r
Craig McKerlie Sr.

Start by reviewing the Configuration Guide example and the referenced TheHive4/README.md commit. Inventory the documentation passages with grammar, capitalization, readability, or consistency concerns before proposing a uniform scope. Done means the affected documents and editorial changes are explicitly identified and the resulting set is consistent.