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.

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

[DOC] Writing style guide for contributors #68

Closed
NHomer-Edi opened this issue Apr 13, 2022 · 2 comments
Closed

[DOC] Writing style guide for contributors #68

NHomer-Edi opened this issue Apr 13, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@NHomer-Edi
Copy link
Collaborator

Describe the proposed improvement to the documentation

So that the book remains consistent, it would be nice to have a "style guide" included in the contributor documentation so that contributors know how to write narrative pieces for the book.

For example, I notice some inconsistencies between the use of “Deep Learning” & “deep learning” and “Environmental data science” & “Environmental Data Science” and "AI" & "Artificial Intelligence"

Additional information

Other things this could include:
• Rules on capitalisation.
• A list of accepted abbreviations and acronyms which will be at the beginning/end of the book so that they do not need to be defined by every contributor.
• Number formatting like time and date and “%” vs. “per cent”.
• Punctuation guidelines.
• Formatting guidelines including bold/italic/underline and links

@NHomer-Edi NHomer-Edi added the documentation Improvements or additions to documentation label Apr 13, 2022
@acocac
Copy link
Member

acocac commented Apr 13, 2022

@NHomer-Edi thanks for the suggestion of a writing style guide! This is a great idea which we can implement as a new section within the Publishing guidelines.

I'll create a pull request linked to the issue so we can work together in the proposed section.

fyi, I'm also planning to have a discussion of a new version of the EnvDS book which will integrate the dashboard idea and a more friendly gallery for the executable notebooks. Let's discuss it in my return (:

@acocac
Copy link
Member

acocac commented Apr 16, 2023

Closing as we've considerably improved the guidelines for authors, including a more friendly gallery, see #126

@acocac acocac closed this as completed Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants