Style guide for book content

[bartaxyz]

Since this book encourages everyone to become a part of it by contributing (either in authoring content or in editing), it's essential to have a good style guide & quality standards in place.

Here's an outline that can inspire the style guide (won't necessarily be written in this manner specifically).

Introduction

• Purpose of the style guide
• Importance of consistency

Writing Principles

• Clarity over cleverness
• Audience consideration
• Active voice preference
• Use of inclusive language
• Formatting and Structure

Heading hierarchy and usage

• Paragraph lengths and breaks
• Use of lists (ordered and unordered)
• Highlighting critical information (bold, italics, etc.)
• Markdown specifics (e.g., how to handle links, images, and tables)
• Tone and Voice

Desired tone (e.g., authoritative, conversational, etc.)

• Use of first-person vs. third-person
• Handling jargon and technical terms
• Citations and References

Importance of giving credit

• How to cite sources within the text
• Format for the references section at the end
• Footnotes

When and how to use footnotes

• Linking back to the main content
• Graphics and Visuals

Image formatting and placement

• Captioning and crediting images
• Use of diagrams, charts, and other visual aids
• Code and Technical Specifications

Code formatting and syntax highlighting

• Commenting and annotating code snippets
• Handling long code blocks
• Language and Grammar

Preferred spellings (e.g., American English vs. British English)

• Punctuation rules (e.g., Oxford comma, use of semicolons)
• Commonly confused words and terms
• Tools and Resources

Recommended tools for writing and editing (e.g., Obsidian)

• External links to Markdown tutorials or grammar guides

Conclusion

• Encouraging feedback on the guide

[bartaxyz]

Ready at STYLE_GUIDE.md