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

Update editorial-style-guide.md #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Durgesh4993
Copy link

@Durgesh4993 Durgesh4993 commented Jan 15, 2025

Issue No. #40

Overview

This PR introduces several updates to the Base Editorial Style Guide to improve consistency, clarity, and alignment with Base’s core principles. The updates include improvements in tone, voice, and terminology, ensuring the style guide better reflects Base’s evolving goals and audience.

Changes Made

1. Clarification on Base Naming Conventions

  • Before: The guide suggested avoiding terms like "Base Chain" and "$BASE."
  • After: Added clarification to always use ‘Base’ (capitalized) and explicitly avoid referring to it as "Base Network" for simplicity and clarity.

2. Updated Terminology for Blockchain Concepts

  • Before: The terminology surrounding blockchain and decentralized technology was somewhat inconsistent.
  • After: Introduced specific changes:
    • Use ‘Onchain’ (not ‘on-chain’ or ‘On Chain’) to standardize terminology across materials.
    • Added ‘ETH denomination’ to emphasize cryptocurrency pricing in global terms instead of USD or other fiat currencies.
    • Emphasized simplifying technical jargon and focusing on examples to make the content more accessible to non-experts.

3. Builder-Centric Language

  • Before: The guide lacked specific emphasis on Base's support for the broader community of builders.
  • After: Added a section that encourages frequent emphasis on builders, developers, creators, and innovators in Base communications. This reinforces Base’s core mission of empowering individuals who are building the decentralized future.

4. Use of Analogies to Simplify Complex Ideas

  • Before: Technical terms were not always explained with practical examples.
  • After: Included a guideline to use analogies or relatable examples to explain abstract concepts like smart contracts and gas fees, making technical subjects more approachable.

5. Updated Writing Guidelines

  • Before: The writing guidelines focused on basic clarity but needed more detail on tone and style.
  • After: Revised writing principles:
    • Emphasized clarity and brevity with examples for active voice.
    • Suggested a direct yet human tone with instructions to use contractions for a more conversational style.
    • Highlighted optimism in Base’s messaging while acknowledging challenges in a grounded manner.

6. Tone and Voice Improvements

  • Before: The tone was somewhat formal and lacked emotional engagement with the community.
  • After: The tone was revised to be:
    • Human-centric, more approachable and engaging.
    • Appreciative, acknowledging the contributions from the community and builders.
    • Solutions-focused, ensuring that messaging always highlights how Base addresses key challenges in blockchain development.

7. Common Mistakes to Avoid

  • Before: Some of the writing advice lacked focus on industry-specific pitfalls.
  • After: Included specific recommendations:
    • Avoid overuse of superlatives, e.g., "world’s best" or "largest ever."
    • Refrain from using aggressive marketing language or making financial predictions.
    • Prevent negative comparisons with other projects to maintain positive engagement.

8. Number and Punctuation Guidelines

  • Before: The punctuation rules were basic but needed clearer consistency.
  • After: Added details on:
    • Using the Oxford comma consistently.
    • Placing em dashes with spaces around them.
    • Writing numerals for 10 and above while spelling out smaller numbers.
    • Formatting thousands and millions in K and M.
    • Including AM/PM and time zones with a clear date format for consistency.

Conclusion

The updates made in this PR enhance the overall readability, clarity, and accessibility of the Base Editorial Style Guide. The changes help maintain Base’s voice as approachable, human-centric, and builder-focused, with a consistent and professional tone throughout. These improvements align with Base’s mission of fostering an inclusive and innovative decentralized ecosystem.

Please review the proposed updates and provide feedback.

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Jan 15, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

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

Successfully merging this pull request may close these issues.

2 participants