メニュー
Audit and synchronize documentation across website, READMEs, and docs/. Use when verifying docs are aligned after feature changes, SDK updates, CLI changes, or release preparation. Detects drift between website content, markdown docs, and SDK READMEs.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
| name | doc-sync |
| description | Audit and synchronize documentation across website, READMEs, and docs/. Use when verifying docs are aligned after feature changes, SDK updates, CLI changes, or release preparation. Detects drift between website content, markdown docs, and SDK READMEs. |
| argument-hint | feature area to audit or "full" for complete audit |
Audit and synchronize documentation across all surfaces to prevent drift.
| Surface | Location | Purpose |
|---|---|---|
| Website docs | src/website/src/components/DocsContent.astro | User-facing docs page with code examples |
| Website i18n | src/website/src/i18n/{en,ca,es}.ts | Translated strings for website |
| Root README | README.md | Project overview, install, quick start |
| GHA README | github-action/README.md | GitHub Action usage and inputs |
| CLI docs | docs/pull-command.md, docs/push-command.md | CLI command reference |
| GHA docs | docs/github-action.md | GitHub Action detailed docs |
| SDK READMEs | src/sdks/{dotnet,python,typescript}/README.md | SDK-specific install and usage |
| SDK examples | examples/sdk/{dotnet,python}/README.md | Example code with explanations |
| Changelogs | docs/changelogs/{cli,gha,sdk-*}.md | Per-component changelogs |
| ROADMAP | ROADMAP.md | Feature status tracking |
Determine which feature area to audit:
docs/pull-command.md, docs/push-command.md, website DocsContentgithub-action/README.md, docs/github-action.md, website DocsContentsrc/sdks/{runtime}/README.md, examples/sdk/{runtime}/,
website DocsContent + Sdks.astro, i18n stringsFor each feature area, identify the authoritative source:
| Area | Source of Truth |
|---|---|
| CLI flags/options | src/envilder/apps/cli/entry/Cli.ts |
| GHA inputs | github-action/action.yml |
| SDK public API | SDK source code (src/sdks/{runtime}/) |
| Providers | src/envilder/core/infrastructure/ |
| Map-file format | envilder.json (example) + copilot-instructions |
For each documentation surface, check:
Cli.tsaction.ymlaws/azure naming across all docsPresent findings in a structured table:
## Documentation Drift Report
| Surface | File | Issue | Severity |
|---------|------|-------|----------|
| Website | DocsContent.astro | Missing --profile flag in CLI section | High |
| SDK README | src/sdks/python/README.md | load() example uses old API | High |
| Root README | README.md | Version badge outdated | Low |
## Alignment Actions
1. {file}: {what to update}
2. {file}: {what to update}
For each drift item:
pnpm lint to check for formatting issuesUse this matrix to ensure consistency when updating a feature:
| When you change... | Also update... |
|---|---|
CLI flag in Cli.ts | docs/pull-command.md or docs/push-command.md, root README, DocsContent, i18n |
GHA input in action.yml | github-action/README.md, docs/github-action.md, website DocsContent, i18n |
| SDK public API | SDK README, examples README, website DocsContent + Sdks.astro, i18n |
| New SDK added | Run full sdk-release-checklist skill (version badge, changelog, i18n, docs) |
| SDK version bump | Bump canonical source file; changelog entry; website picks up version at build time |
| New provider | All provider listings: root README, website Providers.astro, DocsContent, SDK READMEs |
| Map-file format | Root README, all SDK READMEs, website DocsContent |
| ROADMAP status | ROADMAP.md, website Roadmap.astro |
Workflow for investigating and reproducing bugs before fixing via TDD. Use when a bug report or GitHub issue is received. Covers issue fetching, root cause analysis, reproduction planning, and handoff to TDD cycle.
CRAP score quality gate for code complexity and test coverage. Use when reviewing methods for complexity risk, deciding whether to split methods, or determining minimum test coverage requirements.
Code smell detection and safe incremental refactoring patterns. Use when improving code structure, reducing technical debt, or cleaning up after a TDD cycle. Covers SOLID principles, smell catalog, and the propose-apply workflow.
Five independent analysis perspectives for code review: correctness, architecture, security, conventions, and complexity. Use when reviewing PRs, commits, or local changes. Includes severity model and output format.
Index of Architecture Decision Records (ADRs) for cross-cutting technical decisions. Use when making design choices, reviewing proposals for consistency with prior decisions, or onboarding to understand why specific tools or patterns were chosen. Covers test tooling, SDK architecture, code quality, and acceptance test infrastructure.
Git commit messages, PR workflow, and branching strategy using Conventional Commits and Semantic Versioning. Use when creating commits, pull requests, or managing Git workflow.