search

openaustralia / righttoknow

Theme for, and issues specific to, Right To Know.
https://www.righttoknow.org.au/
MIT License
21 stars 14 forks source link

Make the text in the Right To Know help sections clearer and more direct #420

Open kat opened 9 years ago

kat commented 9 years ago

There are lots of instances of "you can" in RTK's help sections. Remove them all. In one or two places, 'then' works much better instead. When I find those that can be replaced by 'then' I'll list them here.

benrfairless commented 9 years ago

I might take a crack at this tonight if I can find time

benrfairless commented 9 years ago

Clarification in #447 (Thanks @kat!):

I should have been more specific about the wording of this ticket. It's about being more direct. I want to remove "you can" in places where it is unnecessary, not replace 'you can' with another way of saying that, such as "its possible to" or "you must be able to". "You can" is active language and preferable to the passive "its possible to". For a more detailed explanation, and a world of speaking more clearly, dive into GDS writing guide.

kat commented 9 years ago

@brfairless sorry to have wasted your time on alternative ways of saying 'you can'. The writing guide is well worth spending quality time on. I know you will find it helpful. Consider reading the guide along with rereading the help pages, and maybe you'll find new issues to document.

essymo commented 7 years ago

Hi @benrfairless Are you still working on this?! if its still an issue I would like to help :)

equivalentideas commented 7 years ago

Hi @benrfairless Are you still working on this?! if its still an issue I would like to help :)

Hey @essymo :) I've just renamed this issue to catch it up with the development on this issue https://github.com/openaustralia/righttoknow/issues/420#issuecomment-81991734 I think it's about making improving the wording in the help sections generally and using https://www.gov.uk/guidance/content-design/writing-for-gov-uk as a bit of a guide.

This is a pretty tricky issue. I think a good place to start would be to identify the sections of text that are problematic, then suggesting alternatives.