Use this checklist before publishing any article to verify it meets the standards for both human readability and AI retrievability. Each item maps to a best practice covered in Gen AI friendly content.
Structure & headings
- H1, H2, and H3 headings are used hierarchically, no levels are skipped.
- Each heading is descriptive and specific, not generic (avoid "Overview," "Introduction," "Details").
- No heading is repeated within the same article.
- Relevant keywords appear naturally in headings.
Paragraphs & flow
- Sentences are short. Ideally under 20 words and direct.
- Each paragraph covers a single idea or task.
- Filler, background context, and tangential information are removed or linked to separately.
- Each section is modular and concise. Ideally under 500 tokens (~375 words).
Lists & tables
- Bullet points are used for grouped, unordered information.
- Numbered lists are used for sequential steps.
- Lists contain 3–7 items and each item is parallel in structure.
- Tables are used for structured data (parameters, settings, comparisons).
- All table columns have descriptive headers.
- All table cells contain descriptive text. No Y/N, dashes, emojis, or icons.
- No merged cells or inconsistent table formatting.
Code snippets
- Code is clean, consistently indented, and correctly formatted.
- Inline comments explain logic and intent.
- Syntax highlighting or language tags are applied.
- Code blocks are copyable. No line numbers or decorative styling.
- A context statement is included for API or product-specific code.
Images & links
- Every image has meaningful, descriptive alt text.
- Alt text avoids vague labels like "screenshot."
- Captions or surrounding text provide additional context where needed.
- All anchor text is descriptive. For example, "Learn how to manage private workspaces" instead of "here," "this," or "click here."
- Internal links connect to related articles where relevant.
SEO & metadata
- Keywords appear naturally in headings, section openers, and key body text.
- A meta description is written with the article's main keywords.
- Structured metadata (title tag, description, custom fields) is applied where supported.
- Terminology is consistent with glossary-approved terms.
Skills & AI workflow
- If a SKILL.md was used, the output has been reviewed for accuracy and completeness before publishing.
- No sections were skipped without reason. If a section is omitted, it is genuinely not applicable.
- Voice and tone match MSTP conventions: second person, present tense, active voice, no marketing language.
- FAQs produced by the skill are self-contained and sourced from real user questions, not generated filler.
GEO (Generative Engine Optimization)
- The article opens with a direct answer to the primary user question within the first 2 sentences.
- Each section is self-contained and makes sense when read in isolation, without requiring surrounding context.
- Key terms and definitions are stated explicitly, not assumed from context.
- No critical information is buried in the middle of a long paragraph — surface it in a heading, list, or callout.
- Content is structured so AI can extract a usable answer without reading the full article.
Glossary & terminology
- Approved glossary terms are used exactly as defined. No synonyms or variations.
- Unfamiliar terms are defined or linked on first mention.
- Abbreviations and acronyms are used consistently throughout.
Writing style
- Tone is clear, conversational, and user-friendly.
- Plain language is used; jargon is avoided or explained.
- Second-person ("you") is used in instructional and how-to content.
FAQs
- The article includes 5–10 FAQs in a dedicated section.
- Questions are sourced from real user queries, support tickets, or common product questions.
- Each FAQ answer is self-contained and concise.
AI-specific checks
- AI-generated drafts reviewed for accuracy, tone, and hallucinations.
- The article has been tested in Eddy AI to confirm accurate answers.
- Content is modular enough to be reused across FAQs, chat responses, and summaries.
- Unanswered queries or support feedback have been reviewed and incorporated.