FAI Tutorial Generator

Purpose

Use this skill to create practical tutorials that users can execute end-to-end without guessing hidden steps.

Inputs

Output Contract

A complete tutorial must include all sections below:

1. Learning objective.
2. Prerequisites with exact versions.
3. Architecture summary.
4. Step-by-step implementation.
5. Verification commands.
6. Expected output examples.
7. Common failures and fixes.
8. Next-step improvements.

Step 1 - Build a Strong Outline

{
  "title": "Build a Cost-Optimized RAG API",
  "objective": "Deploy and test a small RAG API with guarded prompts.",
  "estimated_time_minutes": 45,
  "audience": "intermediate",
  "sections": [
    "Prerequisites",
    "Project setup",
    "Index creation",
    "API implementation",
    "Validation",
    "Troubleshooting"
  ]
}

Step 2 - Generate Runnable Steps

Each step should include:

• Why the step exists.
• Exact command or code.
• Expected result.
• What to do if it fails.

# Example verification step
python -m pytest tests/test_smoke.py -q

# Example expected output assertion
assert response.status_code == 200
assert "citations" in response.json()

Step 3 - Add Validation Gates

Step 4 - Include Troubleshooting Tree

Step 5 - Add Quality Checklist

Before finalizing a tutorial, verify:

• No hidden assumptions.
• All commands are copy-paste runnable.
• Versions are pinned.
• Security-sensitive steps avoid hardcoded secrets.
• The tutorial can be completed within stated time.

Authoring Template

# <Tutorial Title>

## Objective
<One measurable goal>

## Prerequisites
- Tool A version x.y
- Tool B version x.y

## Steps
### 1. <Step>
Why:
Command/code:
Expected result:

## Verification
<commands and expected outputs>

## Troubleshooting
<table>

## Next Steps
<2-3 upgrades>

Notes

• Prefer deterministic examples over vague pseudo-steps.
• Prefer short runnable snippets over long unexplained code dumps.
• Include both success criteria and failure diagnostics.