code-sample-checker

Planned: verify that code samples in documentation are syntactically valid, use current APIs and package versions, are consistent across languages, and run where possible. Use when a writer asks to test, validate, or update code snippets, examples, or quickstarts in docs. Scaffold only; not ready for use.

跳到安装查看文件

仓库: GitbookIO/docs-skills
最近来源活动: 2026年10月27日 11:55
检测到的 SKILL.md 语言: 英语
星标: 0
Forks: 0

安装方式

默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。

用 AI 助手安装

复制这段 Prompt，发给你正在使用的 AI 助手。

Follow https://skillsmp.com/skill-install/prompt.md to install only the Agent Skill at https://github.com/GitbookIO/docs-skills/tree/main/skills/code-sample-checker.

直接命令不会经过审查 Prompt；运行前请先检查来源。

npx skills add https://github.com/GitbookIO/docs-skills --skill code-sample-checker

命令会保持在同一行。复制前请横向滚动并检查完整内容。

想先保存到本地？可下载 SkillsMP 当前能够提供的文件。

检查来源文件

决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。

SKILL.md

来源说明 · 只读预览

name: code-sample-checker
description: Planned: verify that code samples in documentation are syntactically valid, use current APIs and package versions, are consistent across languages, and run where possible. Use when a writer asks to test, validate, or update code snippets, examples, or quickstarts in docs. Scaffold only; not ready for use.

# Code sample checker Find and check every code sample in a docs set so that copied examples work for readers and agents. ## Status Scaffold only — not ready for use. ## Planned - Extract fenced code blocks with their language tags and surrounding context - Lint or parse each sample for its language and flag missing language tags - Flag deprecated APIs, outdated package versions, and placeholder values that are not explained - Run safe, self-contained samples in a sandbox when the user allows it - Check that equivalent samples in different languages do the same thing

在 GitHub 查看

返回搜索返回安装

release-notes-writer

Draft clear, user-facing release notes and changelog entries from merged pull requests, commits, tickets (Linear, Jira, GitHub issues), diffs, or internal notes, grouped by impact and written in the team's existing voice. Use when a writer asks to write release notes, a changelog entry, a what's-new update, or a summary of what shipped between two tags, dates, or versions. Filters out internal-only changes, calls out breaking changes and deprecations with migration steps, links entries to docs, and never invents behavior the sources do not support.

2026-10-30

accessibility-checker

Planned: review documentation for content accessibility issues, including missing or poor image alt text, skipped heading levels, non-descriptive link text, color- or position-only instructions, inaccessible tables, and unexplained abbreviations. Use when a writer asks to check docs for accessibility, alt text, or inclusive and readable content. Scaffold only; not ready for use.

2026-10-27

ai-readiness

Check or fix documentation pages for AI readability, so AI assistants, Ask AI, RAG pipelines, and other LLM retrieval systems can retrieve, chunk, and quote them accurately. Use when a writer asks whether docs are AI-ready or LLM-ready, how pages will chunk for retrieval, or to audit or fix pages for AI assistants. Runs checks A-1 to A-10 (description, opening paragraph, headings, empty sections, section length, tables, values in images, leading pronouns, link text, SUMMARY.md listing) and reports a pass or fail per page with the offending line.

2026-10-27

查看这个仓库的全部 Skills

code-sample-checker

来源信息

安装方式

用 AI 助手安装

检查来源文件

同仓库更多 Skills

用 AI 助手安装

同仓库更多 Skills