跳到正文
cccskills
免费在 GitHub 公开

review-onboarding-docs

Research-only audit of product and device documentation for first-time users. Use when explicitly asked to review, critique, assess, or audit getting-started, installation, setup, configuration, or support docs; or when a bold, high-level documentation strategy with five recommendations is needed. Do not use to edit documentation.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol星标 1,120(GitHub 1,120 + cccskills 0)

实测评分 未实测

查看安装方法

包含的文件(2)

  • SKILL.md4.1 KB
  • agents/openai.yaml239 B

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Review Onboarding Docs

Audit documentation from the perspective of a capable but non-developer first-time device owner. The goal is a calm, obvious path from choosing the product through installation, setup, configuration, and successful everyday use. Advanced material must remain available without interrupting that path.

This is research only. Inspect, analyse, and recommend; do not edit files, create issues, commit, or open a pull request.

Establish the user journey

  1. Identify the intended new-user outcomes: understand what is needed, install the device safely, connect it, configure it, confirm it works, and know where to get help.
  2. Find the current entry points, navigation, key guides, prerequisites, installation instructions, configuration references, troubleshooting, and advanced/developer content. Follow links as a new user would.
  3. Identify the audience assumed by each page. Treat unexplained technical vocabulary, hidden prerequisites, and choices without decision guidance as friction.
  4. If external research would materially improve the assessment, browse current, authoritative examples of onboarding or technical-documentation practice. Use it to inform principles, not to copy a competitor's structure. Cite sources in the report.

Evaluate the experience

Assess the documentation as a journey, not as isolated pages. Look for:

  • A clear starting point, purpose, expectations, supported hardware, and prerequisites.
  • A linear happy path with visible progress, decision points, confirmation checks, and recovery when something fails.
  • Plain language, short purposeful steps, and images/diagrams only where they reduce ambiguity.
  • Separation of task guides (what a new owner must do) from reference material (every option and detail).
  • Progressive disclosure: newcomers encounter only the minimum needed next; advanced configuration, integrations, variants, migration notes, and developer material are reachable but do not dominate.
  • Information architecture, navigation labels, duplication, contradictory instructions, stale material, and dead-end links.
  • Safety-critical steps, irreversible actions, privacy/network considerations, and realistic troubleshooting.

Do not preserve a weak structure merely because it already exists. Consider bold alternatives such as a new onboarding hub, task-oriented navigation, consolidating duplicate material, moving detailed configuration into a reference area, or retiring/moving pages that obscure the primary path.

Form recommendations

Prioritise changes by their likely improvement to successful first-time setup, not by how easy they are to make. Use direct evidence from the documentation. Clearly separate observed facts from inferences.

Return a concise report with:

  1. Journey verdict — one paragraph: who the current docs serve well, where a newcomer is likely to stall, and the most important structural problem.
  2. Five high-impact suggestions — exactly five, ordered by impact. For each include:
    • a decisive title and the problem it solves;
    • evidence, naming the relevant pages/areas;
    • the recommended end state, including substantial reorganisation when warranted;
    • how advanced content becomes progressively discoverable;
    • the user benefit and a practical success signal.
  3. Suggested future structure — a compact proposed top-level navigation or learning path, when reorganisation is one of the recommendations.
  4. Scope boundary — list material that should stay advanced/reference-only rather than be placed in the main onboarding flow.

Avoid a long issue inventory, minor wording edits, or generic advice. Be direct about material that should move, merge, split, or be removed from the newcomer path. Do not make documentation changes in this run.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Clean up completed Git branches and worktrees for this repository both locally and on GitHub. Use when the user asks to remove complete, completed, merged, stale, finished, or done branches, delete merged GitHub branches, tidy local worktrees, prune completed PR branches, or clean up branches and worktrees after pull requests have merged.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

Clean up local branch worktree folders for this repository after their branches or pull requests have merged to main. Use when the user asks to remove merged branch folders, tidy local worktrees, clean old feature branch directories, prune merged PR worktrees, or clean up local development folders without impacting main.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

compile

免费

Test compile ESPHome firmware for all devices using Docker and fix any YAML or configuration errors until every device compiles successfully. Use when the user says "/compile", "test compile", "compile check", "build test", "check builds", "verify compile", or wants to make sure all devices compile before committing.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

Review EspControl repository changes specifically for missing, stale, excessive, or misplaced documentation. Use when the user asks for a documentation coverage review, asks whether a feature or behavior change is concisely documented, invokes $docs-review, or explicitly wants docs checked as a secondary pass during a pull request, branch, or local diff review.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

Provide an expert codebase review for this repository. Use when the user says "Expert Review" or "/expert-review", asks for an expert review, wants refactoring or codebase improvement recommendations, wants consistency and quality assessed, or asks how to reduce duplication, improve component use, preserve the end-user experience, and keep upgrades cleanly migratable.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

Reimagine this repository from first principles using the current product and user experience as the target. Use when the user says "/expert-reset", asks how the project should be rebuilt if starting again, wants bold architecture or component-structure recommendations, or wants a research-only reset plan unconstrained by current implementation details.

中文简介正在准备中。当前显示原文说明。

jtenniswood/espcontrol11202026年10月26日 更新

查看 jtenniswood 的全部技能

报告此技能的问题