This article will help you to write your content in a clear and consistent way. Please use it as a reference when you’re writing for Eshopbox. You can refer to this for all types of articles you write at Eshopbox.

Before you start

Someone reading your article is usually looking to answer a specific question. Your goal should be to provide answers without distraction. Consider your audience’s background, goal, and current mood. Ask these questions to yourself:

• Is my content readable to all kinds of users, like a new user or an experienced user?

• What is the goal of the user?

• What task do they need to complete?

• What topic do they need to research?

Guidelines

Follow the below guidelines to write the articles for Eshopbox:

Self-contained ‘index’

Before committing to writing, structure/index your article. List down the step-by-step topics involved in the article. Add headings that are simple and self-contained. Try to stick to 3-5 steps per article to avoid overloading readers.

Guide readers with good ‘title’

Titles organise articles and guide readers. A title appears at the beginning of the article briefly describes the content that follows. Avoid using punctuation in the title. The article should be in the title case. Do not use the full stop or question mark in the title.
Right: Article Content Guidelines
Wrong: Content guidelines for article

Give structure with ‘headings and subheadings’

Headings and subheadings organize content for readers. Be generous and descriptive. Headings (H1) give people a taste of what they’re about to read. Subheadings (H2, H3, etc.) break articles into smaller, more specific sections. Follow the below points when you are writing headings and subheadings:

• We should organise headings and subheadings in a hierarchy, with heading first, followed by subheadings in order. (An H2 will nestle under H1, and H3 under H2, and on down.)

• Include the most relevant keywords in your headings and subheadings, and make sure you cover the main point of the content.

• Use sentence case for writing headings and subheadings

• Avoid using question forms of heading. You should always use question marks for FAQ.
  Right: Adding a team member
  Wrong: How to add a Team Member?

Follow ‘active voice’ for clarity

Use the active voice. Writing in the active voice is more clear, conversational, and engaging than the passive voice. In an active voice, the subject of the sentence does the action. In passive voice, the subject of the sentence has the action done to it. Avoid the passive voice as much as possible.
Right: We will receive your inventory.
Wrong: Your inventory is being received.

Avoid unnecessary capitalization'

Use sentence case. Don't capitalise random words in the middle of sentences. You can only use capital letters after full stop or navigation. For example, Navigate to Consignment> Inwards.
Right: You can view the inward consignment in the Eshopbox workspace.
Wrong: You can view the Inward Consignment in the Eshopbox workspace

Use ‘US English’ instead of ‘UK English’

Always follow American English rather than using British English. If you are using Grammarly, keep the ‘writing in’ setting to American English.
Right: Center
Wrong: Centre

Access Grammarly

Break the ‘long sentences’

Do not use a long sentence. The sentence should not exceed 12 words at a time. Long sentences can slow a description or time dragging. Short sentences are more punchy, quick and dynamic, and are suitable to describe.
Right: The sentence should not exceed 12 words at a time. Long sentences can slow a description or time dragging.
Wrong: The sentence should not exceed 12 words at a time because long sentences can slow a description or can be time dragging.

Replace multiple "ings."

Try not to use multiple ‘ing’ in a single sentence. Choose -ing words carefully and replace them with more powerful or descriptive verbs.

Include ‘notes or tips’

When to include a special note - tips, tricks. This can help readers to pay extra attention to an important point. This can be used for additional information too.

Use ‘colon’

Use a colon (rather than an ellipsis, em dash, or comma) to offset a list.
Right: You can create three types of product on Eshopbox: base product, kit, and virtual combo
Wrong: You can create three types of product on Eshopbox- base product, kit, and virtual combo

Define ‘abbreviations'

Spell out abbreviations the first time you mention them. Then use the short version for all other references.
First use: Network Operations Center (NOC), Fulfilment Center(FC)
Second use: NOC, FC

Support content with ‘screenshots’

Always put a supporting screenshot with the description. This can help the reader to understand the practical scenario. The screenshot should be followed by a description. Do not put a screenshot before the description.

Fill ‘forms’ for screenshots

If there is a form in the screenshot, it should be filled in. Values filled in the form should have very relevant information.  (No -  Test, Dummy, etc.). For example,

Open

 Define ‘field information’

When you want the user to fill any detail in a given field:

• Mention the objective (why you need to fill this field),

• If there are only some specified values (e.g., dropdown, multi-select), each value's meaning may be specified. 

• If there are special validations like unique, etc. - It should be mentioned.

• If the field is not mandatory. Provide info that this can be skipped.

• If the field is not editable. Provide information.

Avoid ‘repetition’

Do not use repetitive methods to describe one thing. E.g., If you are defining the meaning of a building block, define it in one exact sentence. Write the second sentence only if you have any additional information to add.

‘Educate’ as expert

Tell readers what they need to know, not just what we want to say. Please give them the exact information they need, along with opportunities to learn more. Remember that you’re the expert, and readers don’t have access to everything you know.

Be ‘Clear’ and ‘precise’

Understand the topic you’re writing about. Use simple words and sentences. Do not use words like ‘some,’ ‘any.’ Be precise about what you are writing.

Write for ‘all readers’

Some people will read every word you write. Others will just skim. Help everyone read better by grouping related ideas together and using descriptive headers and subheaders.

‘Linking’ for referring

Provide a link whenever you’re referring to something on an external website or page. Use links to point users to relevant content and trusted external resources.

• Don’t include preceding articles (a, an, the, our) when you link text. For example:

  • Right: Read the automation guide for details.

  • Wrong: Read the automation guide for details.

  • If a link comes at the end of a sentence or before a comma, don’t link the punctuation mark.

  • Don’t say things like “Click here!” or “Click for more information” or “Read this.” Write the sentence as you normally would, and link relevant keywords. You can use Learn more at the end of the paragraph.

Use ‘positive language’

Use positive language rather than negative language. One way to detect negative language is to look for words like “can’t,” “don’t,” etc.
Right: Create consignment before sending inventory to Eshopbox
Wrong: You cannot send your inventory to Eshopbox if you have not created your consignment.

Limit ‘paragraphs’

Try to break the paragraphs into different paragraphs. Long paragraphs can be bearing and confusing for readers. If possible, do not exceed 70 words in one paragraph.

Use ‘bulleted lists’

Bulleted lists are easier to scan and read than full paragraphs. If you are listing three or more items, consider using a bulleted list.

Use ‘sample values’ to illustrate

Use some standard examples to illustrate the data. Use sample values to represent the data in screenshots or examples. You must not use actual data for illustration purpose. For example,

• Right: Brand Name is a name given by the maker to a product or range of products, especially a trademark. Here, you will mention the name of your brand. This field is non-editable.

  Example: Kapas kraft, Zozo, etc.

• Wrong: Brand Name is a name given by the maker to a product or range of products, especially a trademark. Here, you will mention the name of your brand. This field is non-editable.

  Example: Montecarlo, Raymond, etc.