pipeline/aeo_guidelines.py

"""AEO / AI-chatbot-citation writing guidelines injected into the blog-writing prompt.

Distilled from the writing-relevant parts of
"Best Practices for Being Listed and Cited in AI Chatbot Queries"
(V:\\GameMaster\\Marketing\\AEO\\ai_chatbot_citation_best_practices_gamemaster.docx).

Only the guidance that applies to authoring a single article is included here — site-wide
technical items (robots.txt, sitemaps, schema/JSON-LD, llms.txt) are out of scope for a
generated blog post and are intentionally omitted.
"""

# Kept as a single prompt-ready block. Referenced by writer.write_post().
AEO_GUIDELINES = """\
Write the article to be easily discovered, quoted and CITED by AI answer engines
(ChatGPT, Claude, Gemini, Perplexity, Google AI Overviews). Follow these rules:

Core formula: be specific + be useful + show original proof + be quotable.

1. Direct answer first: open with a one-sentence, self-contained definition/answer to the
   article's core question, then a short direct-answer paragraph — all within the first
   ~100 words. A reader (or model) should get the answer without scrolling.
2. Answer-friendly structure: use clear, descriptive H2/H3 headings; where natural, phrase
   headings as the questions users actually ask. Each section should directly answer its
   heading. Keep paragraphs short (2-4 sentences) and use bullet lists so points are easy
   to extract and quote.
3. Be specific, not generic: prefer concrete, verifiable, extractable statements over vague
   marketing claims. (Weak: "the best tool for everyone." Strong: name the exact features,
   numbers, versions, steps or limitations.) Every claim should be something a model could
   quote and attribute.
4. Include at least one comparison or feature table (Markdown table syntax) when the topic
   supports it — comparisons, feature/module matrices, specs, pros/cons or step summaries.
5. Include a short FAQ section near the end: 3-6 real questions a user might ask an AI,
   each with a concise, direct 1-3 sentence answer (great for citation).
6. Trust / E-E-A-T: cite reliable primary sources by name inline where you make factual
   claims, and add a brief "Sources" list at the end referencing them. Show experience and
   state limitations or caveats honestly (what does NOT work, what needs manual review).
7. Freshness: include a "Last updated" line (use the current month/year) near the top or end.
8. Descriptive link text: when you reference a concept, use strong descriptive anchor
   phrasing — never "click here", "read more", "this article" or "learn more".
9. Self-contained: put the important details in plain text prose; do not defer key facts to
   the images. Images illustrate; the text must stand alone.
"""