Writing Style
This guide is here to create a consistent style our readers can come to trust and learn from. At all times, we must balance technical knowledge with the casual, friendly banter of hobby spaces.
When writing for FujoGuide, think of yourself as a knowledgeable friend, rather than a formal instructor. You are deeply invested in the reader’s success, have a strong belief in their abilities, and yet relate to their present struggles—you too have been an intimidated beginner once!
Tone and Voice
Section titled “Tone and Voice”Your tone should balance credibility and approachability by being:
Practical & Instructional:
- Set clear expectations for the reader and stick to what you’ve outlined.
- Keep steps simple: one action per step.
- Action and consequences should be clearly labeled and follow logically.
- Write with the expectation that your reader is following along with your instructions, so don’t lead them to a metaphorical cliff without warning clearly that the risk is there
| Do | Do not |
|---|---|
|
|
Approachable & Conversational:
- Your reader should feel spoken to, not lectured at.
- The occasional meme or inside joke to break the tension is welcome, as long as it doesn’t derail the flow of information.
- Keep the wording simple and accessible.
- Don’t be afraid of teaching people technical jargon when appropriate, but make sure to define it clearly in approachable terms.
| Do | Do not |
|---|---|
|
|
Empathetic & Reassuring:
- Remember, friends helping friends is the goal.
- Our audience comes to us for help, trusting that we won’t judge them for struggling, and we’ll do our best to answer in a way they can understand.
- Our goal is to empower our audience to use this knowledge in their own projects.
| Do | Do not |
|---|---|
|
|
Genuine & Empowering:
- There’s no single right way of doing things: what we offer is a specific option.
- Our ulterior motive is to unlock coding as a path for self-expression, not to dictate what that self-expression should look like.
- Avoid hierarchical speech: we’re all peers helping each other.
- We do this because we genuinely love technology and the possibilities it unlocks, and want our friends to love it and use it too.
| Do | Do not |
|---|---|
|
|
Language Conventions
Section titled “Language Conventions”The following conventions help us craft effective explanations that are easy to parse and absorb. These rules aren’t meant to be prescriptive, but are a starting point to craft sentences from, and a tool to review them with:
-
Language Standard:
- Stick to standard American English.
- Online parlance is welcome when appropriate.
- Be mindful of slang that can be misconstrued as aggressive, negative or hurtful.
- Use inclusive, neutral language.
- Avoid making readers feel ostracized because they don’t understand the references or jokes.
- Hate speech has no place in our work.
- Do not make people or categories of people the butt of the joke.
-
Language Clarity:
- Prioritize direct, unambiguous writing.
- Use language well:
- Prefer an active voice to be more direct, clear, and engaging—unless it makes a simple explanation convoluted!
- Cut unnecessary words (“
in order to => to”) - Prefer strong verbs over nouns (“
perform an installation => install”) - Prefer positive framing when you’re not giving an explicit warning (“
Don’t do [x] unless [y] => if [y] do [x]”) - Use transition words to smooth connections between sentences and paragraphs.
- Get to the point quickly:
- When introducing a concept, start with a straightforward definition (“
Git is a program to manage changes to your files…”, “Absolute file paths specify the file location starting from the root…, “Commands are instructions you give to your Terminal…”) - When explaining how to achieve a goal, prefer stating the goal first (“
To install a new library, you can run npm add [x]”, “To know the directory you’re currently in, use the pwd command”)
- When introducing a concept, start with a straightforward definition (“
- Break down complex ideas in multiple sentences and paragraphs. If a sentence is getting long, consider:
- moving the subject or central point closer to the beginning
- reframing it as multiple sentences
- using bullet points to break it down into parts
-
Economy of Language:
- Make sure you cover the important parts without long-winded explanations. Respect readers’ time and attention span!
- The main content should prioritize information that is useful (the reader will need it to achieve their goals) and timely (is relevant to what they’re currently learning)
- If an important explanation doesn’t quite fit, consider whether it can:
- be featured in a more appropriate place
- grouped with other useful explanations to create a larger topic
- Use asides to call out special cases, or to give more advanced explanations most readers can safely skip
-
Purposeful Language:
- Be consistent: Use the same terms throughout the article and match the rest of the site–let us know where we got this wrong ourselves!
- Define key terms: Clearly define terms and concepts when you first introduce them. Use bold to highlight the core part of the explanation to aid skimmability. Make sure the bold part reads like a sentence!
- Spell out acronyms: When you introduce an acronym, explain what it stands for. You can choose whether to use:
- Term (acronym): if the full term is common or it helps initial understanding (“
A Version Control System (VCS) helps people…”) - Acronym (term): if the acronym is frequently encountered in the wild (“
NPM (Node Package Manager) is a powerful tool that…”) - Separate Sentences: if the expansion requires more context or you want to elaborate on its meaning (“
HTML defines the structure of your websites. Its name stands for HyperText Markup Language, highlighting its ability to…”)
- Term (acronym): if the full term is common or it helps initial understanding (“
- Clarify confusion: explicitly call out terms that are often mixed up (e.g.
terminal programvsscriptvscommand) and differences across systems (e.g.path separators). When the differences are not important, acknowledge that and, if needed, add further explanations in an aside. - Avoid filler words: Remove words that do not add value or clarity to the sentence. If you can say it in five words, don’t say it in ten.