-
Notifications
You must be signed in to change notification settings - Fork 177
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
Set a tone / style for the book #25
Comments
@belen-albeza thanks for bringing this up! I tried looking around for some style guides that would capture the above points and started working on https://github.com/tooling/authoring-styleguide. It's super-rough, but perhaps we could evolve it? Currently inspired by Rubenstein, O'Reilly authoring portal and MailChimp's style guide for their content. |
If anyone has any comments or ideas for improving the style guide, I'd be happy to take them on-board. Otherwise we can continue iterating on it and suggest it as a guideline for those authoring chapters. |
@addyosmani are you expecting alot of visuals for v1 please? How many-ish? |
Imo, our guidance around the use of visuals should be liberal - i.e if an author feels that visuals aid the chapter, then by all means feel free to use them. One example might be demonstrating the output of a particular build step where you might be generating a bunch of files and it's beneficial to show the file tree of what was created. |
In order to provide something uniform (it's good for readers), we should decide which tone or style use. Stuff like:
Maybe the easiest way would be just have a text or book we like and adopt their style / conventions choices.
The text was updated successfully, but these errors were encountered: