Agent Skillsoperately/operately › help-docs

help-docs

GitHub

扫描Git历史以发现自基线以来的用户可见变更,识别需文档化的功能并推断UI行为。用于审计发布后的文档缺口或生成帮助文档内容。

.agents/skills/help-docs/SKILL.md operately/operately

Trigger Scenarios

审计自特定版本或SHA以来的文档需求 根据代码变更识别文档缺口

Install

npx skills add operately/operately --skill help-docs -g -y
More Options

Non-standard path

npx skills add https://github.com/operately/operately/tree/main/.agents/skills/help-docs -g -y

Use without installing

npx skills use operately/operately@help-docs

指定 Agent (Claude Code)

npx skills add operately/operately --skill help-docs -a claude-code -g -y

安装 repo 全部 skill

npx skills add operately/operately --all -g -y

预览 repo 内 skill

npx skills add operately/operately --list

SKILL.md

Frontmatter
{
    "name": "help-docs",
    "description": "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."
}

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.

Action When
new_page New user capability with no matching help page
update_page Existing flow, labels, or navigation changed
api_auto_sync External API surface changed — CI publishes to /help/api/
skip Internal-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

Version History

  • 379b061 Current 2026-08-20 12:01

Same Skill Collection

.agents/skills/components-architecture/SKILL.md
.agents/skills/ecto-migrations/SKILL.md
.agents/skills/mcp-tools/SKILL.md
.agents/skills/ui-copy/SKILL.md
.agents/skills/writing-tests/SKILL.md
.agents/skills/clean-code/SKILL.md

Metadata

Files
0
Version
379b061
Hash
f5eca864
Indexed
2026-08-20 12:01

- 위키
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-25 09:21
浙ICP备14020137号-1 $방문자$