Editorial Guidelines
By following these guidelines, we can ensure that our content is consistent, accurate, and engaging.
By Almon Subba,Vadim Zolotokrylin
Have a suggestion?
Edit ArticleThis guide is part of our Core Principles: holdex.io/c/learn/...
Introduction
The purpose of these guidelines is to provide a framework for contributors to create content that aligns with our messaging, voice, and tone.
To run the editorial process smoothly, we have established a clear workflow:
- identify the topic and purpose of the content
- ensure consistency across all content on Holdex
- double-check formatting guidelines, grammar and punctuation
Before publishing, all content will be reviewed by the editorial team (responsible individual) to ensure that it meets high standards of quality, accuracy, and alignment with our brand.
We encourage everyone to follow these guidelines closely to ensure that the content meets expectations and contributes towards better content on this site.
Wondering what we can provide through our partnership? Discover our services
Content Topic
First, ensure you have an end goal in your mind. You must know what you want to tell the reader and the purpose of it.
Knowing this will help determine how you want to go ahead with working on it.
Here are topic examples: #guides, #defi, #people, etc.
Headings
When you create content, the best way is to start with a backbone structure of your content. It is because headings define your main topic ideas, sections sequence and priority.
Headings are one of the most important elements. If you have a bad heading, all your text will look and feel bad.
Hierarchy
Make sure the main headings are larger than the subheadings. This helps to create a visual hierarchy and guide the user's eye.
Always style your headings with an appropriate option.
Note on H1
As we are publishing all content via the Holdex Google Docs extension, we don’t use “Heading 1” (H1) styling inside the draft document. This is because the H1 content is defined in the extension itself.
Keep it short
Short and to the point headings work the best. Avoid using them in longer sentences or on conjunction words (and/for etc).
Capitalizing Subheadings
Capitalizing subheadings or certain key/buzz words can be an effective design choice to draw attention to them, especially if they are short and concise. It can help break up the text and make it easier to read, as well as create visual interest on the page.
However, it's important to use this design element consistently throughout the website and not overuse it. Too many capitalized subheadings can make the text look cluttered and difficult to read. Ultimately, the design choice should serve the purpose of enhancing the overall user experience by making the content more accessible and readable.
Here are some general guidelines for using this design element:
- Be consistent: Use the same formatting style for all subheadings throughout the website.
- Use sparingly: Don't overuse capitalized subheadings as it can make the text look cluttered and difficult to read.
Test it out: As with any design element, test and see if it enhances the overall user experience or not. It is not compulsory to include it everywhere.
Length of the Article
Article length may be no longer than 3000 words. Use words counter to make sure you don’t exceed this limit.
Grammar and Punctuation
Make sure to use correct grammar and punctuations all the time when writing articles. Makes it easier when proofreading as we keep errors to a minimum and speed the process.
Adding Authors
If you need to add additional authors, add the list. Only use authors with links (as for now only links are parsed). Place the authors on the header of the document, otherwise the parser will not pick it up.