Token导航 LogoToken导航TokenDH.com
研究检索执行命令github未标认证来源可访问许可证需确认审计通过

docs-update文档更新

Agent Skill

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

总安装

791

周安装

32

GitHub Stars

6

下载量

248
CodexClaudeCursorGemini CLI

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

unknown

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:docs-update(文档更新)
来源仓库:https://github.com/duc01226/easyplatform
仓库路径:skills/docs-update
安装命令:
npx skills add https://github.com/duc01226/easyplatform --skill docs-update
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

skills.shnpx skills
npx skills add https://github.com/duc01226/easyplatform --skill docs-update

简介

docs-update 用于辅助文档、README 和内容稿件的整理与改写,提炼结构、统一术语并检查链接。

  • 适用于 Markdown、说明文等文本的优化,保留项目事实与路径,避免未确认信息写成确定结论。
  • 通过 npx skills add 命令从指定 GitHub 仓库安装使用。
  • 涉及对外文案时需控制语气,避免过度营销或夸大能力。
  • 适用宿主包括 Codex、Claude、Cursor、Gemini CLI,接入前应确认版本、权限和运行环境要求。

SKILL.md

[IMPORTANT] Use TaskCreate to break ALL work into small tasks BEFORE starting — including tasks for each phase. For simple tasks, AI MUST ATTENTION ask user whether to skip.
Critical Purpose: Single orchestrator for ALL documentation sync after code changes. Triages impact, then delegates to specialized skills.
Evidence Gate: MANDATORY IMPORTANT MUST ATTENTION — every claim, finding, and recommendation requires file:line proof or traced evidence with confidence percentage (>80% to act, <80% must verify first).

Quick Summary

Goal: Detect which documentation is impacted by code changes and orchestrate updates across all doc types.

Orchestration Model:

git diff → Triage → Phase 1: Project Docs (inline)
                  → Phase 2: /feature-docs (business feature docs)
                  → Phase 3: /tdd-spec (test specifications)
                  → Phase 4: /test-specs-docs (dashboard sync)
                  → Phase 5: Summary Report

Key Rules:

  • This skill is a router — it triages, then invokes sub-skills. No duplicating sub-skill logic.
  • Each phase checks whether it's needed before invoking — skip phases with no impact.
  • Always report what was checked, even if nothing needed updating.
  • Pass triage context (changed files, detected modules, impacted sections) to each sub-skill via $ARGUMENTS.

Be skeptical. Apply critical thinking, sequential thinking. Every claim needs traced proof, confidence percentages (Idea should be more than 80%).


Phase 0: Triage — Detect Impacted Documentation

Step 0.1: Collect Changed Files

  1. Run git diff --name-only HEAD (captures both staged and unstaged changes)
  2. If no uncommitted changes, run git diff --name-only HEAD~1 (last commit)
  3. If still empty, run git diff --name-only origin/develop...HEAD (branch changes)

Step 0.2: Categorize Changes

Classify each changed file into documentation impact categories:

Changed File PatternImpact CategoryPhases to Run
src/Services/**feature-docs + tdd-spec + project-docs1 + 2 + 3 + 4
{frontend-apps-dir}/**, {frontend-libs-dir}/{domain-lib}/**feature-docs + tdd-spec + project-docs1 + 2 + 3 + 4
{legacy-frontend-dir}/**Client/**feature-docs + tdd-spec + project-docs1 + 2 + 3 + 4
src/{Framework}/**project-docs only1 only
docs/**project-docs only1 only
.claude/**, config files onlynoneFast exit
{frontend-libs-dir}/{platform-core-lib}/**, {frontend-libs-dir}/{common-lib}/**project-docs only1 only

Step 0.3: Fast Exit Check

If ALL changed files fall into the none category (e.g., only .claude/, .github/, root config files):

  • Report: "No documentation impacted by current changes (config/tooling only)."
  • Exit early — skip all phases.

Step 0.4: Auto-Detect Affected Modules

Extract unique module names from changed file paths:

Changed File Path PatternDetected Module
src/Services/{Module}/**{Module}
{frontend-apps-dir}/{app-name}/**{Module} (map app to module)
{frontend-libs-dir}/{domain-lib}/src/{feature}/**{Module} (map feature to module)
{legacy-frontend-dir}/{Module}Client/**{Module}

Build project-specific mapping by examining:

ls -d src/Services/*/
ls -d docs/business-features/*/

Step 0.5: Check Existing Docs for Each Module

For each detected module:

  1. Check if docs/business-features/{Module}/ exists
  2. Check if docs/business-features/{Module}/detailed-features/ has feature docs
  3. Check if docs/test-specs/{Module}/ exists
  4. Record: hasFeatureDocs, hasTestSpecs, hasTestSpecsDashboard

Phase 1: Project Documentation Update (Inline)

When to run: Changed files include src/{Framework}/**, docs/**, or architectural changes.

When to skip: Only service-layer or frontend feature files changed (no architectural impact). Skip and proceed to Phase 2.

Step 1.1: Spawn Scouts (standalone invocation only)

When invoked standalone (not as a workflow step), spawn scouts for broad codebase context:

  1. Spawn 2-4 scout-external (preferred) or scout (fallback) via Task tool
  2. Target directories that actually exist — adapt to project structure
  3. Merge scout results into context summary

When invoked as a workflow step: Skip scouting — use git diff context from Phase 0 directly.

Step 1.2: Update Project Docs

Pass context to docs-manager sub-agent (Agent tool with subagent_type="docs-manager") to update impacted project docs:

  • docs/project-reference/project-structure-reference.md: Update if service architecture or cross-service patterns changed
  • README.md: Update if project scope or setup changed (keep under 300 lines)

Only update docs that are directly impacted by the changes. Do not regenerate all docs.


Phase 2: Business Feature Documentation — Invoke /feature-docs

When to run: Triage detected modules with hasFeatureDocs = true AND service/frontend files changed.

When to skip: No service-layer or frontend feature files changed. Report: "No business feature docs impacted."

Step 2.1: Determine Create vs Update

ScenarioAction
Module has existing feature docsInvoke /feature-docs — auto-detect mode will trigger update flow
Module has NO feature docsReport: "Module {Module} has no feature docs. Run /feature-docs to create." — skip
User explicitly asked for full doc creationInvoke /feature-docs with explicit module name

Step 2.2: Invoke /feature-docs

Execute the /feature-docs skill with triage context:

/feature-docs Update feature docs for modules: {detected modules}.
Changed files: {list from triage}.
Impacted sections based on change types: {section impact from triage}.
Mode: update (existing docs only, do not create from scratch).

What /feature-docs handles (DO NOT duplicate here):

  • 17-section structure enforcement
  • Diff analysis → section impact mapping
  • Codebase analysis (entities, commands, queries, controllers)
  • Update impacted sections with evidence
  • Master index update (BUSINESS-FEATURES.md)
  • 3-pass verification (evidence audit, domain model, cross-reference)
  • CHANGELOG entry
  • v3.0 principles (no code details in S1-14, evidence in S15 only)

Step 2.3: Review /feature-docs Output

After /feature-docs completes, verify:

  1. Updated sections align with triage's section impact mapping
  2. No sections were missed that the triage identified as impacted
  3. If gaps found → re-invoke /feature-docs for missed sections

Phase 3: Test Specifications — Invoke /tdd-spec

When to run: ANY new functionality was added (new commands, queries, endpoints, components) OR existing behavior changed.

When to skip: Changes are purely cosmetic (styling, comments, docs-only) with no behavioral impact.

Step 3.1: Determine TC Mode

Based on triage context, determine the appropriate /tdd-spec mode:

ContextTC Mode
New feature code, no existing TCsimplement-first
PBI/story exists, code not yet writtenTDD-first
Existing TCs + code changes / bugfixupdate
User says "sync test specs"sync
Tests exist with annotations, no docsfrom-integration-tests

Step 3.2: Invoke /tdd-spec

Execute the /tdd-spec skill with triage context:

/tdd-spec Mode: {detected mode}.
Modules: {detected modules}.
Changed files: {list from triage}.
New functionality detected: {new commands/queries/endpoints from diff analysis}.

What /tdd-spec handles (DO NOT duplicate here):

  • 5 modes: TDD-first, implement-first, update, sync, from-integration-tests
  • TC-{FEATURE}-{NNN} format with decade-based numbering
  • Interactive TC review with user (AskUserQuestion)
  • Cross-cutting categories: authorization, seed data, performance, data migration
  • Phase-mapped coverage (plan phases → TCs)
  • Graph context analysis for cross-service impact
  • Evidence verification per TC
  • Write to feature doc Section 15 (canonical TC registry)

Step 3.3: Review /tdd-spec Output

After /tdd-spec completes, verify:

  1. New TCs cover all new functionality identified in triage
  2. TC IDs don't collide with existing ones
  3. Evidence fields are populated (not template placeholders)

Phase 4: Test Specs Dashboard Sync — Invoke /test-specs-docs

When to run: Phase 3 produced new or updated TCs, OR docs/test-specs/ exists and may be stale.

When to skip: No test specification changes and no docs/test-specs/ directory exists.

Step 4.1: Invoke /test-specs-docs

Execute the /test-specs-docs skill:

/test-specs-docs Sync test specs for modules: {detected modules}.
Direction: forward (feature docs Section 15 → docs/test-specs/ dashboard).
Updated TCs from Phase 3: {list of new/changed TC IDs}.

What /test-specs-docs handles (DO NOT duplicate here):

  • Forward sync: feature docs → dashboard
  • Reverse sync: dashboard → feature docs (when requested)
  • 3-way comparison: feature doc vs test-specs/ vs test code
  • PRIORITY-INDEX.md management
  • Module dashboard generation
  • Integration test cross-reference ([Trait("TestSpec",...)])

Step 4.2: Review Sync Results

After /test-specs-docs completes, verify:

  1. All new TCs from Phase 3 appear in dashboard
  2. PRIORITY-INDEX.md updated with correct priority tiers
  3. No orphaned TCs (in dashboard but not in feature docs)

Phase 5: Summary Report

Always output a summary of what happened:

### Documentation Update Summary

**Triage:** {N} files changed → {categories detected}
**Modules detected:** {module list}

**Phase 1 — Project Docs:**
- {Updated/Skipped}: {reason}

**Phase 2 — Business Feature Docs (/feature-docs):**
- Module {X}: {Updated sections A, B, C / No existing docs / Not impacted}
- Module {Y}: {Updated sections D, E / Skipped: no feature docs}

**Phase 3 — Test Specifications (/tdd-spec):**
- Mode: {mode used}
- New TCs: {list of TC IDs added}
- Updated TCs: {list of TC IDs modified}
- Skipped: {reason if skipped}

**Phase 4 — Dashboard Sync (/test-specs-docs):**
- {Synced N TCs to dashboard / Skipped: no dashboard exists}
- Discrepancies: {any 3-way comparison issues}

**Recommendations:**
- {Any new docs that should be created}
- {Any stale docs flagged but not auto-fixed}
- {Any TCs flagged as Untested}

Decision Matrix: When docs-update Orchestrates vs Direct Skill Invocation

ScenarioUse docs-update?Use skill directly?
Post-implementation doc sync (any code change)Yes — full orchestration
Create new feature docs from scratchNo/feature-docs
Generate TCs for a specific PBI (TDD-first)No/tdd-spec
Sync dashboard only (no code changes)No/test-specs-docs
Workflow step after /code or /fixYes — full orchestration
User asks "update docs after my changes"Yes — full orchestration

Additional Requests

<additional_requests> $ARGUMENTS </additional_requests>


Next Steps

MANDATORY IMPORTANT MUST ATTENTION — NO EXCEPTIONS after completing this skill, you MUST ATTENTION use AskUserQuestion to present these options. Do NOT skip because the task seems "simple" or "obvious" — the user decides:

  • "/watzup (Recommended)" — Wrap up session and check for remaining doc staleness
  • "/workflow-review-changes" — Review all changes before commit
  • "Skip, continue manually" — user decides

Closing Reminders

MANDATORY IMPORTANT MUST ATTENTION break work into small todo tasks using TaskCreate BEFORE starting. MANDATORY IMPORTANT MUST ATTENTION validate decisions with user via AskUserQuestion — never auto-decide. MANDATORY IMPORTANT MUST ATTENTION add a final review todo task to verify work quality.

适合场景

01

用户想查找某类 Agent Skill 时

02

需要根据任务场景推荐可安装能力包时

03

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

Codex

37.14%
按下载量换算92

Claude

29.92%
按下载量换算74

Cursor

19.05%
按下载量换算47

Gemini CLI

9.21%
按下载量换算23

安全审计

Gen Agent Trust Hub

通过

Socket

通过

Snyk

通过

权限和风险

执行命令

安装流程涉及命令执行,可能通过 npx skills add https://github.com/duc01226/easyplatform --skill docs-update 联网下载 Skill 或依赖。用户安装前应确认命令来源、仓库内容和执行环境。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills