Skip to content

Commit

Permalink
Merge pull request #32 from lucacurranCB/patch-1
Browse files Browse the repository at this point in the history
Update editorial-style-guide.md
  • Loading branch information
zencephalon authored Aug 28, 2024
2 parents 5ce7f4e + b0a9e4f commit 2c200ec
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions guides/editorial-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Base is an Ethereum Layer 2 (L2) offering a secure, low-cost, builder-friendly w
- **Use the word ‘onchain’** instead of ‘web3’ or ‘crypto’ — and it's spelled "onchain" or "Onchain" not "on-chain" or "on chain" or "On Chain"
- **Use technical terms sparingly**, and when you do, work to explain them in full
- **Use ETH demonination, not USD when referring to prices**, to emphasize the global economy
- **Have your brand supercede Base** (BRAND x Base, not Base x BRAND) in text and or logos

## Writing Guidelines

Expand Down Expand Up @@ -83,6 +84,21 @@ Here’s an example of writing that feels appropriate in both tone and voice:
- [A Word About Style, Voice, and Tone](https://www.umgc.edu/current-students/learning-resources/writing-center/online-guide-to-writing/tutorial/chapter3/ch3-21.html) - “When you hear an author talking inside your head, “voice” is what that author sounds like. \[] You can develop your own voice in your writing by paying special attention to rhythm, diction, and punctuation.”
- [Point of View](https://www.merriam-webster.com/words-at-play/point-of-view-first-second-third-person-difference) - First, second, or third person? Omniscient, limited, or objective? Check for consistency.

## What to Avoid
The Base core team does its best to amplify builders who positively contribute to the Base ecosystem. To increase your chances of amplification on social channels, please avoid the following:

- **Using Financial Terminology**: Refrain from terms indicating gains, profits, investments, high yields, etc. Avoid phrases like "lucrative opportunity."
- **Mentioning Specific Tokens or Airdrops**: Focus on the value, gameplay, or experience instead of specific tokens, points, or airdrops.
- **Disputable Superlative**s: Avoid using unverified superlatives like “the best” or “fastest performing.”
- **Unapproved Partnerships**: Do not reference a “partnership” or “collaboration” unless explicitly approved by someone on the Base team.
- **Overly Aggressive Marketing**: Avoid aggressive marketing tactics, promotions, and discounts, as they may send the wrong message within the Base ecosystem.
- **Non-Compliant Contests or DeFi Offers**: Do not offer contests, sweepstakes, or DeFi applications without compliant terms of service.
- **False or Misleading Information**: Ensure all information shared is accurate and truthful.
- **Technical Jargon**: Avoid overly technical jargon or corporate language that may alienate your audience.
- **Negative Comparisons**: Refrain from putting down other projects or competitors.
- **Offensive Language**: Do not use offensive or explicit language in any communication.


## Clarity, Concision, and Flow

“The goal is to make your paper as simple and clear, as immediately intelligible to the reader as possible. This doesn’t mean that you should ignore subtle and sophisticated complexities in your theory – but the challenge is to **state those complexities simply and clearly**. Avoid making your subject seem more complex than necessary (for example, if something “creates habits”, it’s probably neither necessary nor helpful to say that it “exhibits a habit-formation process”).” \~ [R. Wicks](https://www.academia.edu/75129398/Stylebook_Tips_on_Organization_Writing_and_Formatting)
Expand Down

1 comment on commit 2c200ec

@smirnovslava189
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling and Formatting
"on-chain" or "on chain"
While the text specifies that "onchain" should be spelled as one word, it redundantly lists alternate spellings. This can be consolidated for clarity.

Correction:
Remove "on-chain" or "on chain" or "On Chain" to avoid unnecessary repetition.

Redundancies
Repetition in "Use technical terms sparingly..."
The guideline emphasizes explaining technical terms fully. However, this is restated multiple times throughout the text.

Correction:
"Use technical terms sparingly, explaining them fully where necessary." simplifies the instruction.

Awkward Phrasing
"Have your brand supercede Base"
The correct spelling is "supersede," not "supercede."
Inconsistencies in Style
Inconsistent Capitalization
For example, "BRAND x Base" uses full capitalization for "BRAND," while "Base x BRAND" does not. Consider standardizing capitalization conventions for readability and professionalism.
Ambiguities
"ETH demonination, not USD..."
"ETH denomination" is misspelled as "demonination." Additionally, clarify whether this applies to all mentions of prices or only within specific contexts.
Structure and Flow
In "What to Avoid" Section
Some items are repetitive or redundant:

"Overly Aggressive Marketing" and "False or Misleading Information" could overlap if a clarification isn't provided.
"Non-Compliant Contests or DeFi Offers" might benefit from specifics or examples.
Correction:
Group related items or provide brief examples for clarity. E.g., "Avoid misleading promotions, including aggressive marketing, false claims, or non-compliant contests."

Technical Errors
"Disputable Superlative" vs. "Disputable Superlatives"
The phrase "Disputable Superlative" should be plural to match the context.
Readability
Long Sentence in Clarity Section
The sentence:

"This doesn’t mean that you should ignore subtle and sophisticated complexities in your theory – but the challenge is to state those complexities simply and clearly."

Can be split for better readability.

Correction:
"This doesn’t mean you should ignore subtle complexities. The challenge is to state them simply and clearly."

By implementing these corrections, the text will achieve improved clarity, precision, and professionalism.

Please sign in to comment.