ContentstackHealth-Check Template

Having a Content Type name that is meaningful and semantic enables content authors to easily comprehend the purpose of the content type. Furthermore, including a description can offer supplementary contextual information.

Using descriptive and semantic field names makes it effortless for content authors to understand the purpose of the field, even without any reference to designs or other artifacts.

To enhance the experience, consider including "Help Text" and "Instructions", as well as "Default Value" or "Placeholder" text to provide a more detailed guide.

For ensuring that only the right type and amount of content is added, it is essential to enable field validation. To accomplish this, you can leverage options such as Regex validation, validation error messages, mandatory fields, and so forth.

The Group field enables users to cluster similar fields together and make the content more organized. This can be acheived using the "Group" Field.

Content authors are not required to have knowledge of HTML. Inserting HTML code directly into the CMS goes against the very purpose of a headless CMS.

Adding raw HTML fields can result in poor author experience, semantic markup and styling issues, and increase the likelihood of broken content.

Live Preview allows content managers to preview entry content across multiple channels before publishing, enabling real-time side-by-side previews of changes.

Kindly note that this feature is limited to a specific plan and browser-based applications.

By using semantic values, visual elements such as color, direction, and alignment can be mapped without relying on absolute values. This approach ensures that the values are not tied to a particular resolution, device, or theme, providing greater flexibility in designing and adapting interfaces.

Example 1: When defining clolor values, it's recommended to use semantic values such as "Dark", "Light", "Primary", "Secondary", etc. instead of RGB or HEX codes. Semantic values provide meaningful and intuitive descriptions of colors, making it more accessible.

Example 2: Using absolute alignment or directional values such as "left" and "right" can be confusing in a responsive layout, as they can have different meanings depending on the context. Moreover, languages such as Arabic, which are written from right to left, require a reversed page layout. Therefore, it is not recommended to use absolute values for alignment or direction. Instead, it is better to use relative or semantic values that adapt to the context.

Reference Field are the best fit for reusable content as it ensures that the data is derived from a single source.

With the Modular Blocks field, it is possible to create dynamic content blocks that can include a variety of blocks such as plain text, or more complex blocks such as Carousels and Grids. It provides a flexible approach to content creation allowing to build custom experience / layout with ease.

By using Global fields, you can create a set of fields only once and then include it in multiple content types.

Ensure that group fields with multiple instances have a group title. This provides a way to identify the instance when the fields are collapsed in the Entry editor.

The JSON RTE stores content in a JSON formate that can be comprehended and processed by all programming languages, whereas the HTML RTE is restricted to HTML markup.

JSON based content offers developers greater flexibility and interoperability in rendering.

Using CSS Classnames from the CMS limits the content's flexibility to be utilized in multiple designs / future designs. This can lead to a suboptimal authoring experience too!

It is recommended to use alternative concepts such as "Variants" or mapping to a semantic value as described above.

As much as we can the content should be future proofed for new designs. Hence focusing on having a structured content is important. Some of the points to consider are

• Loosely attaching the fields to visual designs helps with future proofing the content types and styles.
• Separation of presentation from Structured content. Example: Products, Brands, Events, Authors.

Using a single source for images is highly recommended. Contentstack's Image API can be used to resize, manipulate, and optimize images for responsive designs and similar use cases.

The following Metadata will help with the SEO.

• Title tag (Around 70 characters)
• Meta Description (a concise summary of the content, with around 160 characters)
• Meta Keywords (5-10 relevant keywords)
• Meta Robots (determining how search engines should treat the page)

Collecting the relevant information through fields included in the Content Model is crucial for generating the schema markup. For example, to generate the Product Schema Markup, specific fields might be necessary to gather the required details.

Alt text provides better image context/descriptions to search engine crawlers, helping them to index and rank an image properly in image search.

Having search engine friendly URLs is not only important for improving website's ranking in search results, but it also enhances the user experience by making the site easier to navigate. This, in turn, can increase the amount of time users spend on your site and the number of pages they visit, ultimately improving your overall SEO. Additionally, search engine crawlers use URLs to establish connections between pages, providing even more benefits for your website's SEO.

The default API response sometimes may have additional information that are unnecessary. Validate the data and filter out anything that shouldn't be there. Use projection queries such as only to retrieve/exclude specific field data for each entry.

The best practice is to limit your response payload to 5 MB.

It is recommended to keep the number of includes (when referencing other entries) and the depth levels as low as possible. The best practice is to restrict your total include to not exceed 10. However it depends on the user’s requirement and their final response payload size, which should be restricted to the ideal response size.

It is advisable to limit the size of URLs to 5KB or less. This size includes the length of the hostname, path, query string, and any additional headers or parameters that may be part of the request.

Although there is no strict limit on the size of an entry, it is advisable to keep it below 1MB. When an entry becomes excessively large, it can adversely affect your application's performance.

It is important to regularly review the tokens and take necessary actions. Here are some pointers to review:

• Delete unused tokens.
• Use a convention based naming to ensure that the purpose and usage of each token are easily understandable.

Using workflows for content governance in Contentstack can enhance collaboration, streamline the content approval process, maintain content compliance, and improve content quality.