Open gaurav-nelson opened 5 years ago
Hiya! We should definitely have a basic style guide, and I agree it makes sense to use an off-the-shelf one. However, I might swerve away from the government guides, or the big style manuals. (1) This is not technical documentation. While the writing needs to be clear, it does not need to be formal or strict. (2) The big style guides can be quite overwhelming. Ideally, we want something that allows people to quickly check basic conventions (what heading case should they use etc.), and gives brief guidance on tone.
Perhaps something like the MailChimp style guide, or even just the TLDR from it: https://styleguide.mailchimp.com/tldr/
MailChimp also has the advantage that someone has already done the Vale setup: https://github.com/testthedocs/vale-styles/tree/master/MailChimp
Yup, that makes sense. Let's add it to the contributing topic.
At the moment contribution guidelines are in the README - do you want to add it and make the PR if you are looking for more hacktoberfest material? :-)
I have already completed my 4 PRs for Hacktoberfest, so no more PR's till next year (❁´◡`❁)
JK, I'll take this one.
Haha thank you! I think I need to do another pass over contribution guidelines and stuff at some stage, but for now just make it a section in the README (Style and tone or something like that)
We should add a writing (and style) guide that dictates the language and word usage when creating or editing topics. Rather than creating our own, I suggest that we should use some common already available guidelines. I don't know how complete is the Writing for GOV.UK topic ?
We also have similar Writing Style from Australian government. Maybe we can combine it with Microsoft or Google style guides or similar.