atlan-review-doc-sync
Run findings-first review for Atlan app changes and synchronize app documentation with implemented behavior. Use when completing a change set, preparing handoff, or auditing regressions.
Best use case
atlan-review-doc-sync is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Run findings-first review for Atlan app changes and synchronize app documentation with implemented behavior. Use when completing a change set, preparing handoff, or auditing regressions.
Teams using atlan-review-doc-sync should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/atlan-review-doc-sync/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How atlan-review-doc-sync Compares
| Feature / Agent | atlan-review-doc-sync | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Run findings-first review for Atlan app changes and synchronize app documentation with implemented behavior. Use when completing a change set, preparing handoff, or auditing regressions.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Atlan Review Doc Sync Produce high-signal review findings and keep docs aligned. ## Workflow 1. Review code and tests with bug/risk/regression priority. 2. Report findings first, then brief change summary. 3. Update app-level docs (README, architecture notes, test notes) to match actual behavior. 4. Run `atlan-fact-verification-gate` if behavior-critical claims need source confirmation. 5. Validate implementation against selected quality tier from `../_shared/references/app-quality-bar.md`. 6. Confirm SDK/CLI remain untouched. 7. If CLI mismatch surfaced during review, append proposal entry. ## Rules - Prioritize correctness, regression risk, and missing tests. - Keep review findings concrete with file references. - Do not modify SDK or CLI docs/code. ## References - Review checklist: `references/review-checklist.md` - Quality bar: `../_shared/references/app-quality-bar.md` - CLI proposals: `../_shared/references/cli-change-proposals.md`
Related Skills
atlan-workflow-args-secrets-state
Implement workflow argument retrieval, credential_guid usage, and state store updates using Atlan SDK patterns. Use when workflows or activities handle credentials, runtime args, or persisted workflow state.
atlan-sql-connector-patterns
Select and apply the correct SQL connector implementation pattern (SDK-default minimal or source-specific custom). Use when building or extending SQL metadata/query extraction connectors.
atlan-sdk-objectstore-io-defaults
Enforce object store and IO defaults from the Atlan SDK for output paths, prefixes, and file writes. Use when implementing or reviewing raw/transformed output handling.
atlan-fact-verification-gate
Verify Atlan app behavior against SDK docs/code and CLI docs/code before behavior-changing decisions; use lightweight checks by default and deep checks when risk is high.
atlan-e2e-contract-validator
Generate and validate e2e test contracts for Atlan workflows, including API responses, output paths, and schema assertions. Use when adding or updating workflow e2e coverage.
atlan-cli-run-test-loop
Run Atlan app execution loops using CLI-first commands with automatic CLI availability checks and safe fallbacks.
atlan-cli-install-configure
Install Atlan CLI with OS-aware binaries (or Homebrew on macOS) only when missing, then configure baseline tenant auth/log settings.
atlan-app-scaffold-standard
Scaffold new Atlan apps from CLI templates as the default behavior when users ask for a new app, then align files to sample-app standards.
synchronization
Convergence to common trajectory in coupled systems
performing-serverless-function-security-review
Performing security reviews of serverless functions across AWS Lambda, Azure Functions, and GCP Cloud Functions to identify overly permissive execution roles, insecure environment variables, injection vulnerabilities, and missing runtime protections.
performing-privileged-account-access-review
Conduct systematic reviews of privileged accounts to validate access rights, identify excessive permissions, and enforce least privilege across PAM infrastructure.
performing-oauth-scope-minimization-review
Performs OAuth 2.0 scope minimization review to identify over-permissioned third-party application integrations, excessive API scopes, unused token grants, and risky OAuth consent patterns across identity providers and SaaS platforms. Activates for requests involving OAuth scope audit, API permission review, third-party app risk assessment, or consent grant minimization.