Skip to content

Andamio-Platform/coach / skills/gather-code-examples

gather-code-examples

Unverified

Generate code example checklists for Developer Documentation lessons based on readiness assessment.

Skill: Gather Code Examples

Description

Generates a structured code example checklist from a course's readiness assessment. Used during Phase 6 (Gather Context) of the course workflow to prepare assets for Developer Documentation lessons.

When to Use

  • After /self-assess-readiness identifies Developer Documentation SLTs as "Needs Context"
  • When the Context Shopping List includes code examples or API references
  • Before building Developer Documentation lessons

Invocation

/gather-code-examples                           # Interactive: asks which course
/gather-code-examples andamio-for-api-developers  # Specify course

Instructions

1. Identify Course

If no course specified, scan courses-in-progress/ and ask which course to generate checklist for.

2. Read Readiness Assessment

Read 04-readiness-assessment.md to identify:

  • Which SLTs are "Needs Context" or "Needs Human"
  • Which of those are Developer Documentation lesson type (cross-reference with 03-lesson-type-classification.md)
  • What specific code examples are needed (from Gap Analysis sections)
  • What API references or docs are needed

3. Read Course Outline

Read 00-course.md to get:

  • Lesson focus for each SLT (what code patterns to demonstrate)
  • Lesson inputs specified (what examples were already anticipated)
  • Any specific libraries, frameworks, or APIs mentioned

4. Generate Checklist

Create assets/code-examples/README.md with:

# Code Example Checklist: [Course Name]

**Generated from:** `04-readiness-assessment.md`
**Primary language:** [language]
**Key libraries:** [list]
**Last updated:** [date]

## Environment Requirements

- **Language version:** [e.g., Go 1.21+, Node 18+]
- **Required packages:** [list with versions if known]
- **Test environment:** [e.g., Cardano preprod, local devnet]

## Naming Convention

[slt-number]-[example-name].[ext]


## Checklist

### SLT [X.Y]: [SLT text]

| # | Filename | What to Demonstrate | Status |
|---|----------|---------------------|--------|
| 1 | `X.Y-example-name.go` | [specific code pattern] | [ ] |

**Code requirements:**
- [ ] Compiles without errors
- [ ] Runs against [test environment]
- [ ] Includes comments explaining key steps
- [ ] Error handling demonstrated

**API references needed:**
- [ ] [specific API doc or function signature]

**Verification:**
- [ ] Output matches expected result
- [ ] Tested on [date] against [environment]

---

[Repeat for each Developer Documentation SLT]

## Summary

| SLT | Examples Needed | Verified | Notes |
|-----|-----------------|----------|-------|
| X.Y | [count] | 0 | [brief note] |

**Total:** [n] code examples

## API Documentation Links

| Library | Doc URL | Version | Status |
|---------|---------|---------|--------|
| [name] | [url] | [version] | [ ] Verified current |

## Gathering Session Notes

_Use this space to record observations:_

- Date:
- Tester:
- Environment version:
- Issues encountered:

5. Create Directory Structure

Ensure assets/code-examples/ directory exists:

courses-in-progress/[course-slug]/
  assets/
    code-examples/
      README.md           # The checklist
      1.2-api-auth.ts     # Example files
      2.1-query-courses.ts
      ...

6. Output Summary

After generating, report:

## Code Example Checklist Generated

**Course:** [name]
**Location:** `assets/code-examples/README.md`

| SLT | Example | Language | Dependencies |
|-----|---------|----------|--------------|
| X.Y | [name] | [lang] | [libs] |

**Total:** [n] examples across [m] SLTs

### Dependency Tiers

| Tier | SLTs | What's Needed | Est. Effort |
|------|------|---------------|-------------|
| 1: Standalone | [list] | Language + standard lib only | Low |
| 2: External API | [list] | API key + network access | Medium |
| 3: On-chain | [list] | Test wallet + test ADA | Higher |

**Next step:** Verify API docs are current, then write Tier 1 examples.

Naming Convention

Format

[slt]-[example-name].[ext]

Parts

PartFormatExamplePurpose
sltX.Y1.2SLT number
example-namekebab-caseapi-authWhat the example demonstrates
extlanguage extension.ts, .go, .pyFile type

Examples

FilenameDescription
1.2-api-auth.tsAuthentication example
2.1-query-courses.tsQuerying course data
3.1-build-transaction.goBuilding unsigned transaction
3.2-sign-submit.goSigning and submitting

Code Quality Requirements

Every code example must:

1. Compile/Run

  • No syntax errors
  • All imports resolve
  • Runs without runtime errors (on valid input)

2. Be Complete

  • Self-contained (can copy-paste and run)
  • Includes necessary imports
  • Shows setup and teardown if needed

3. Be Documented

  • Comments explain "why" not just "what"
  • Key steps are labeled
  • Expected output is shown (in comments or separate file)

4. Handle Errors

  • Shows error handling pattern
  • Doesn't silently fail
  • Demonstrates realistic error cases

5. Be Verified

  • Tested against stated environment
  • Output captured and compared
  • Date of last verification recorded

Verification Template

For each example, record:

### Verification: [filename]

- **Tested:** [date]
- **Environment:** [language version, library versions]
- **Test network:** [preprod/mainnet/local]
- **Result:** Pass / Fail
- **Output:**

[actual output]

- **Notes:** [any observations]

Common Example Types

TypePurposeTemplate Pattern
AuthAuthenticate with APISetup credentials → make auth call → store token
QueryFetch dataAuth → build query → handle response → parse data
TransactionBuild/submit txAuth → build unsigned → sign → submit → confirm
CRUDCreate/Read/Update/DeleteAuth → operation → verify result
WebhookHandle callbacksSetup server → register webhook → handle event

Guidelines

  • One checklist per course — Don't split across files
  • Working code only — Never include code that doesn't run
  • Version pin dependencies — Record exact versions tested
  • Test before lesson — Verify examples work before writing lesson content
  • Update on API changes — Re-verify when libraries update
  • Flat directory — No subdirectories per SLT (simpler for organization)
  • Include expected output — Either in comments or companion .output file
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 467kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 196kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 196kUpdated Claude CodeCodexVerifiedInstall