Skip to content
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.

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

writing style guide #24

Open
jcolomb opened this issue Jan 10, 2019 · 4 comments
Open

writing style guide #24

jcolomb opened this issue Jan 10, 2019 · 4 comments

Comments

@jcolomb
Copy link
Contributor

jcolomb commented Jan 10, 2019

Let's write one.
some links given here: OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source#19 :

Nielsen, Jakob. 1997. ‘How Users Read on the Web’. Nielsen Norman Group (blog). 1 October 1997. https://www.nngroup.com/articles/how-users-read-on-the-web/.

‘Writing Digital Copy for Domain Experts’. n.d. Nielsen Norman Group. Accessed 17 November 2017. https://www.nngroup.com/articles/writing-domain-experts/.

Consider those for whom English is a second language, too.
https://meta.wikimedia.org/wiki/Writing_clearly

File to be found https://github.com/OpenScienceMOOC/Main/blob/master/Production_Files/WritingStyleGuide.md

@jcolomb
Copy link
Contributor Author

jcolomb commented Jun 16, 2020

copying slack information:

jennifer go on the coc
https://docs.google.com/document/d/1LOQRIH-NBb1m8sNQz7B8sdcCH55HeQOuTvjPXo6MKbw/edit#

resources:
The resources I am most familiar with on global English are just regular books, The Global English Style Guide: Writing Clear, Translatable Documentation for a Global Market by John Kohl and The Elements of International English Style by Edmond Weiss.
https://vlc.nccommunitycolleges.edu/faculty/accessibility/compliance-standards/

https://ec.europa.eu/info/sites/info/files/styleguide_english_dgt_en.pdf

@jcolomb
Copy link
Contributor Author

jcolomb commented Jun 16, 2020

this may goes with translation, with the first translation being "into international english" then we go to other languages.

NB: international english should be better translated by machines like deepl.com

@mrchristian
Copy link

Hi J,

Yes, OK its on my books :-) I'll assign some time block to this and get on with it. Thanks Simon

@mrchristian
Copy link

I found the file where you want the guide to be written - https://github.com/OpenScienceMOOC/Main/blob/master/Production_Files/WritingStyleGuide.md I'll get to it and pop up on slack

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

No branches or pull requests

2 participants