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

Enhance Clarity and Structure of Editorial Style Guide #25

Open
thegr8liberator opened this issue Aug 5, 2024 · 0 comments
Open

Enhance Clarity and Structure of Editorial Style Guide #25

thegr8liberator opened this issue Aug 5, 2024 · 0 comments

Comments

@thegr8liberator
Copy link

thegr8liberator commented Aug 5, 2024

Summary:
I propose several enhancements to the Base Editorial Style Guide to improve its clarity, structure, and overall usefulness. These changes aim to make the document more navigable and easier to follow for all contributors.

Proposed Changes:

  1. Add a Table of Contents:

    • To improve navigation and readability, especially for longer documents.
    • Example:
      ## Table of Contents
      1. [Introduction](#introduction)
      2. [Why use the style guide?](#why-use-the-style-guide)
      3. [About Base](#about-base)
      4. [Critical Style Conventions](#critical-style-conventions)
      5. [Writing Guidelines](#writing-guidelines)
      6. [Nuances](#nuances)
  2. Clarify Technical Terms:

    • Include a glossary for commonly used technical terms to aid understanding.
    • Example: Define terms like "onchain", "L2", and "ETH" in a glossary section.
  3. Expand on "Why use the style guide?":

    • Provide examples of how consistent messaging benefits the brand and community.
    • Example: Explain how consistency can improve brand recognition and trust.
  4. Simplify Language and Ensure Active Voice:

    • Where possible, simplify complex sentences to improve readability.
    • Ensure guidelines about active voice are reflected consistently throughout the document.
    • Example:
      **Original:** “Experiences that are sticky, that make it easy for anyone to get started, and that offer a seamless user experience that abstracts onchain complexity as much as possible are what we’re looking for.” (passive)
      **Edited:** “We’re looking for experiences that make it easy for anyone to get started and offer a seamless user experience that abstracts complexity as much as possible.” (active)
  5. Provide More Examples:

    • Add examples for each guideline to illustrate correct usage.
    • Example: Provide sample sentences demonstrating the preferred use of technical terms, punctuation, and tone.

Benefits of Proposed Changes:

  • Improved navigation and readability for users.
  • Enhanced understanding of technical terms.
  • Clearer and more consistent guidelines.
  • Better examples to guide contributors.

I welcome any feedback or suggestions for further improvements to these proposed changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant