OpenScienceMOOC / Main

Management materials and content
MIT License
30 stars 13 forks source link

writing style guide #24

Open jcolomb opened 5 years ago

jcolomb commented 5 years ago

Let's write one. some links given here: https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/issues/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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

Hi J,

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

mrchristian commented 4 years ago

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