Seanie Gleason Writing Style Guide

Seanie Gleason Writing Style Guide

This document defines the specific prose and structural patterns used in the blog.

1. Tone and Voice

  • Persona: A Senior Software Engineer/Architect who is hands-on and practical.
  • Diction: Clear, direct, and opinionated. Avoid corporate fluff.
  • Emphasis: Use bolding for impact and italics for “asides” or emphasis.
    • Example: “This is where things get interesting.”

2. Post Structure

Every post should follow this rhythmic flow:

  1. The Hook: A single, bolded sentence at the very top that identifies a common pain point or a strong technical opinion.
  2. The “Problem” Section (H2): Define the challenge. Why does this matter? Use a relevant image here.
  3. The “Solution” Section (H2): Introduce the Spring AI / Technical feature. Use blockquotes or bold italics for the core value proposition.
  4. The Implementation: Provide a clean, concise Java/Spring code snippet. Ensure it is production-ready and follows standard conventions.
  5. The Enterprise Context (H4/H2): Explain why this isn’t just a “cool demo” but a necessity for large-scale production environments.
  6. The Conclusion: A brief summary of the takeaway.
  7. The Signature Sign-off: “That’s it! … thanks for reading, and I’ll see you in the next one!”

3. Formatting Conventions

  • Headers: Use ## for main sections and #### for sub-points.
  • Images: Use the ![](../assets/img/...) syntax. Try to reuse existing high-quality assets like framework.jpg or subway-london.png when they fit the metaphor.
  • Code Blocks: Always specify the language (e.g., ````java`).

4. Common Metaphors

  • Subway/Train maps for “Discovery” or “Navigation.”
  • Construction/Steel beams for “Frameworks” and “Architecture.”
  • Planting/Nature for “Growth” or “Ecosystems.”