跳到正文
cccskills
免费在 GitHub 公开

help-docs

Discover help documentation work from operately git history. Use when the user asks to audit what needs documenting since a release, tag, or SHA, or to identify documentation gaps from code changes. Requires a baseline SHA or tag as input.

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

查看安装方法

包含的文件(2)

  • SKILL.md3.4 KB
  • reference.md9.7 KB

SKILL.md(原文)

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

Help Docs — Change Discovery

Scan git history since a baseline, identify user-facing product changes, and infer how they work from source code.

This skill covers finding what needs documenting and how the feature works in the UI.

For git commands, path watchlists, filter heuristics, code research guidance, and what to capture per candidate, read reference.md.

Input

Required: baseline SHA or tag (e.g. v1.6.0, abc1234).

If the user does not provide a baseline, ask before proceeding.

Scope

  • Work in the operately repo (this repo).
  • Quote UI labels exactly from source; do not polish copy.
  • Optionally cross-check the sibling operately-website repo for existing help pages when it is available on disk.

Workflow

1. Resolve baseline

Validate the SHA or tag exists. Record the range baseline..HEAD, HEAD SHA, and commit count.

2. Collect changes

List merge commits and PR titles in the range. Prefer PR titles over individual commit messages — PR titles use the feat: / fix: / chore: / docs: prefixes.

Use the git recipes in reference.md to gather commits and diffs.

3. Filter to user-facing

Keep changes that affect what users see or do in the app. Drop internal-only work (refactors, CI, tests-only, backend-only, migrations without UI impact). See reference.md — Filter heuristics.

4. Cluster related commits

Group commits by feature area. Multiple PRs for one capability (e.g. billing page + checkout + cancellation) become a single item.

5. Research each cluster in code

For each cluster, read the relevant source to infer behavior:

  • app/assets/js/pages/ — screens and navigation
  • app/assets/js/features/ — feature UI and flows
  • turboui/src/ — shared components
  • app/assets/js/routes/paths.tsx — new or removed routes
  • app/test/features/ — user flows (for validation, not as doc content)
  • specs/ — product intent for major features

Extract entry points, UI labels, step order, permissions, and edge cases. See reference.md — Code research map.

6. Classify and document each cluster

For each cluster, assign a doc action and capture the findings listed in reference.md — What to capture.

ActionWhen
new_pageNew user capability with no matching help page
update_pageExisting flow, labels, or navigation changed
api_auto_syncExternal API surface changed — CI publishes to /help/api/
skipInternal-only; no user-facing doc impact

When operately-website is available, check src/config/helpCenter.js and src/content/docs/help/ to decide between new_page and update_page.

Also record excluded commits and why they were skipped.

Definition of Done

Before finishing, verify:

  • Baseline validated; range and commit count stated
  • Internal-only changes listed with reasons
  • Each candidate cites source commit SHAs and changed file paths
  • UI labels quoted exactly from code
  • Existing help pages referenced when the website repo is available

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Clean-code engineering standards for writing, refactoring, and reviewing code in any programming language. Use this whenever the user asks to write clean code, follow clean-code principles, refactor for clarity, improve naming, reduce complexity or duplication, separate concerns, tighten error handling, work test-first or do TDD, or otherwise raise code quality, readability, and maintainability. Also use when writing or reviewing Operately APIs or Ecto queries. Apply these rules by default when producing or changing code for a quality-conscious user.

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

operately/operately5872026年10月17日 更新

Defines where UI components belong in Operately (TurboUI-first). Use when creating, changing, reviewing, or migrating UI components, adding features that need UI, or deciding whether to refactor legacy app UI in app/assets/js/components or app/assets/js/features. Covers pure TurboUI components, component reuse, the app bridge pattern, and legacy migration scenarios.

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

operately/operately5872026年10月17日 更新

Rules for Operately schema migrations (app/priv/repo/migrations/) and data migrations (app/lib/operately/data/change_*.ex). Use when adding, renaming, reviewing, or generating database migrations, ecto.gen.migration, Operately.Data.Change* modules, backfills, schema_migrations version collisions, mix ecto.migrate, or make gen.migration.

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

operately/operately5872026年10月17日 更新

Maintain Operately translations when adding or changing user-visible copy, fixing missing translations, or adding a supported language. Covers shared Gettext/i18next catalogs, glossaries, generation, and completeness checks; excludes translating user-authored content or general prose outside the product.

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

operately/operately5872026年10月17日 更新

mcp-tools

免费

Defines how to add Operately MCP tools (API-first wrappers). Use when creating, changing, or reviewing MCP tools under app/lib/operately_web/mcp/tools/, when the user mentions MCP tools, tool catalog, @expected_tool_names, or when exposing a new Operately capability to ChatGPT/Claude MCP clients.

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

operately/operately5872026年10月17日 更新

Operately frontend data fetching with TanStack Query. Use when adding or changing page loaders, model hooks, Api.* calls, mutations, useLoadedData, Pages.useRefresh, or any web UI backend request. New code must use TanStack. When fixing or extending an existing surface, migrate that surface's API calls to TanStack in the same change.

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

operately/operately5872026年10月17日 更新

查看 operately 的全部技能

报告此技能的问题