code-sample-documentation
Design, write, review, and test code samples in developer documentation, including executable examples, explanatory snippets, request and response pairs, placeholders, outputs, language choice, sandboxing, and autogenerated samples. Use when docs include API examples, SDK snippets, CLI commands, config examples, tutorials, or code blocks readers may copy.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- code-sample-documentation
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,code-samples,api-docs", "version": "0.1.0", "category": "Writing", "displayName": "Code Sample Documentation" }
- description
- Design, write, review, and test code samples in developer documentation, including executable examples, explanatory snippets, request and response pairs, placeholders, outputs, language choice, sandboxing, and autogenerated samples. Use when docs include API examples, SDK snippets, CLI commands, config examples, tutorials, or code blocks readers may copy.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 3
- 参考文档guidelines.md1.2 KB
- 参考文档references/core/knowledge.md4.7 KB
- 参考文档workflows/review-code-sample.md2.2 KB
03 SKILL.md 正文
Code Sample Documentation
Use this skill to create and review code samples that are useful, accurate, copyable, and maintainable. It applies to executable examples, explanatory snippets, API request/response pairs, CLI commands, config files, and generated references.
This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 5, "Integrating code samples." The guidance is transformed and paraphrased; do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Classify the sample as executable, explanatory, or paired request/response.
- Check whether the sample is explained, concise, clear, usable, and trustworthy.
- Use
workflows/review-code-sample.mdfor a full sample review. - Prefer running or testing samples when feasible; otherwise mark what remains unverified.
Default Output
When reviewing or designing code samples, return:
- Sample purpose - what the reader should learn or accomplish.
- Sample type - executable, explanatory, request/response, CLI, config, or generated.
- Issues or design notes - ordered by reader risk.
- Revised sample - concise and copyable when requested.
- Testing plan - how to verify runtime behavior, outputs, and version assumptions.
- Maintenance notes - source of truth, owner, and generated/manual boundary.
Contents
| Need | Start Here |
|---|---|
| Understand sample types | references/core/knowledge.md |
| Apply sample rules | references/core/knowledge.md |
| See before/after examples | references/core/knowledge.md |
| Review or design a sample | workflows/review-code-sample.md |
| Route by task | guidelines.md |
Core Posture
- A sample is documentation and software; treat it as both.
- Match sample complexity to the reader's stage.
- Make placeholders, inputs, outputs, and limitations explicit.
- Do not imply a sample is production-ready unless it has been reviewed and tested for that use.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.