search

TYPO3-Documentation / TYPO3CMS-Guide-HowToDocument

Guide "Writing Documentation" for contributors and extension authors.
https://docs.typo3.org/typo3cms/HowToDocument/Index.html
9 stars 104 forks source link

[TASK] Put the new "Review Policy" into writing #435

Closed garvinhicking closed 4 months ago

garvinhicking commented 4 months ago

As promised in our last team meeting, I tried to put https://docs.google.com/document/d/1iPQDoGe646r7vqCvgYC11CkwArpZfNT2Xzj2P42Saj4/edit#heading=h.7277wo2jsthg into this manual.

This has not yet been proof-read and is a first version. Please tell me if we're on track with this.

format-gmbh commented 4 months ago

This puts us on the right track.

linawolf commented 4 months ago

Good work! I have only read it superficially until now. I tend to have trouble reading large blocks of text and understand all of it.

This is due to Leghastenia and might be a trouble for non-native speakers as well. What would help me would be shorter sentences, more headlines, shorter paragraphs, lists with keywords instead of very long sentences. However I think the text is already very helpfull and things like this can be made in follow ups

garvinhicking commented 4 months ago

This is due to Leghastenia and might be a trouble for non-native speakers as well. What would help me would be shorter sentences, more headlines, shorter paragraphs, lists with keywords instead of very long sentences. However I think the text is already very helpfull and things like this can be made in follow ups

Sadly I can only do long-form and cannot help with this.