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.

Sign up for GitHub

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

Jump to bottom

Simplify language, consider style guide #254

Open

dtrudg opened this issue Oct 2, 2019 · 0 comments

Contributor

dtrudg commented Oct 2, 2019 •

edited

Loading

Which Document page:

Various, but especially

https://sylabs.io/guides/3.4/user-guide/singularity_and_docker.html

Expected results:

Concepts are expressed as simply as possible.

Actual results:

There is a lot of use of the passive voice, and long sentences. Makes it difficult to skim the documents quickly.

Consider rewriting some sections in simpler English where possible. Consider guides e.g.

http://www.plainenglish.co.uk/files/howto.pdf
http://www.plainenglish.co.uk/files/alternative.pdf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment