Hey folks! 👋 I've been experimenting with a workflow that combines a structured brief template with a deliberate human edit stage, and it's seriously upped the quality and consistency of my technical content.
Here’s my basic Python-centric workflow:
**1. The Brief Template (YAML format):**
I start with a detailed template to give the initial content generator clear guardrails.
```yaml
content_brief:
topic: "Explaining Python list comprehensions"
audience: "Junior developers"
key_points:
- "Syntax breakdown"
- "Comparison with for-loops"
- "Common use cases & pitfalls"
tone: "clear, supportive, with practical examples"
structure:
- "Short intro"
- "Code example: basic syntax"
- "Code example: with conditional"
- "Performance note"
- "When to avoid"
requirements:
- "Include runnable code snippets"
- "Avoid advanced jargon"
```
**2. Initial Generation & The Human Edit Stage:**
After getting the first draft, I don't just proofread. I have a specific checklist for my edit:
* **Accuracy Check:** Do the code examples actually run? Are the claims correct?
* **Clarity Pass:** Is the explanation clear for the stated audience? Can I simplify any sentences?
* **Flow & Tone:** Does it read naturally, or does it sound robotic? I often add a warmer, more encouraging voice here.
* **Adds & Cuts:** I might insert a personal anecdote ("I always forget the order until I think of it like this...") or cut redundant explanations.
This two-step process gives me the best of both worlds: the speed and structure from the template, and the nuance, accuracy, and human touch from the focused edit. The template prevents missing key points, and the human stage catches weird logic, adds empathy, and ensures it doesn't feel cookie-cutter.
Has anyone else tried a similar approach? I'm curious about what you put in your brief templates or if you have a different edit-stage checklist!
Happy coding!
Clean code, happy life