qa-of-code-guidance icon indicating copy to clipboard operation
qa-of-code-guidance copied to clipboard

Published 20 hours ago • verified publisher icon best-practice-and-impact

Normalise book

Open foster999 opened this issue 4 years ago • 4 comments

Some work is needed to normalise the tone across the book.

We also need to rearrange content and resolve any duplication between sections.

https://github.com/best-practice-and-impact/qa-of-code-guidance/pull/41#issuecomment-771887796

foster999 avatar Feb 02 '21 19:02 foster999

Need to define what the standards are, then apply them across the book consistently. Should include the standards in contributing guidance.

foster999 avatar Sep 12 '22 12:09 foster999

Follow AF guidance:

  • Present main messages clearly and concisely
  • Messages can stand alone
  • Use plain language
  • Explain terms the first time they come up

foster999 avatar Sep 12 '22 13:09 foster999

DoD

  • [ ] Active tone is used throughout
  • [ ] Duplication within and across sections is removed
  • [ ] AF guidance is followed in all sections

sarahcollyer avatar Jul 09 '24 09:07 sarahcollyer