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.

Sign up for GitHub

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

Jump to bottom

Normalise book #50

Closed
foster999 opened this issue Feb 2, 2021 · 4 comments · Fixed by #220
Closed

Normalise book #50

foster999 opened this issue Feb 2, 2021 · 4 comments · Fixed by #220
Assignees
@zarbspace @beth-e-jones @ellie-o
Labels
enhancement ✨ New feature or request, or improvements to existing chapters
Milestone
2024.2

Comments

@foster999
Copy link
Contributor

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

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

#41 (comment)
@foster999
Copy link
Contributor Author

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

@foster999
Copy link
Contributor Author

foster999 commented Sep 12, 2022 •
edited
Loading

Follow AF guidance:

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

@sarahcollyer sarahcollyer added this to the 2024.2 milestone Jul 3, 2024
@sarahcollyer sarahcollyer added documentation 📖 Improvements or additions to documentation enhancement ✨ New feature or request, or improvements to existing chapters XL labels Jul 8, 2024
@sarahcollyer
Copy link
Contributor

DoD

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

Sorry, something went wrong.

@sarahcollyer sarahcollyer removed the documentation 📖 Improvements or additions to documentation label Oct 2, 2024
@ellie-o ellie-o self-assigned this Nov 14, 2024
@ellie-o
Copy link
Contributor

ellie-o commented Nov 20, 2024

Have picked up from Beth's work to complete the book excluding the testing chapter (as it's being worked on heavily this sprint).

Reviewed the Tools section, don't believe any changes are needed there.

@ellie-o ellie-o linked a pull request Jan 15, 2025 that will close this issue
50 normalise book #220
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zarbspace zarbspace

@beth-e-jones beth-e-jones

@ellie-o ellie-o

Labels
enhancement ✨ New feature or request, or improvements to existing chapters
Projects
None yet
Milestone
2024.2
Development

Successfully merging a pull request may close this issue.

50 normalise book best-practice-and-impact/qa-of-code-guidance
5 participants
@foster999 @zarbspace @beth-e-jones @ellie-o @sarahcollyer