atlan-review-doc-sync

Automate findings-first review of Atlan app changes and sync documentation.

4|7|Updated Apr 30, 2025

Search Tags:#documentation #verification #quality #review #regression #handoff

Ready to run

npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-review-doc-sync

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: atlan-review-doc-sync
Source: https://github.com/atlanhq/atlan-sample-apps/tree/main/.agents/skills/atlan-review-doc-sync
Command: npx skills add https://github.com/atlanhq/atlan-sample-apps --skill atlan-review-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates findings-first review of Atlan app changes and ensures documentation stays aligned with implemented behavior, reducing handoff friction and regression risk.

Core Features & Use Cases

High-signal review findings: Identify bug risk, coverage gaps, and documentation drift with precise file references.
Documentation alignment: Update app-level docs (README, architecture notes, test notes) to reflect actual behavior.
Governance & traceability: Preserve change history and ensure SDK/CLI remain unchanged during reviews.

Quick Start

Run the skill after a change set is prepared to generate high-signal review findings and align docs with the implemented behavior.

Frequently Asked Questions about atlan-review-doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I review app changes and catch documentation drift?▼

Findings-first review automates detection of bug risk, coverage gaps, and documentation misalignment by analyzing code, tests, and architecture against app-level docs. It generates high-signal findings with precise file references and flags where README, architecture notes, and test notes diverge from implemented behavior.

When should I use documentation sync during handoffs or regression audits?▼

Run documentation sync after preparing a change set to ensure app docs reflect actual behavior before handoff or regression testing. It reduces handoff friction and regression risk by preserving change history while aligning SDK/CLI documentation with implemented changes.

Can documentation review enforce quality standards during code changes?▼

Yes. The skill enforces verification against quality bars during change sets, updates app-level documentation to reflect actual behavior, and can trigger fact-verification gates when source confirmation is required for sensitive changes.

What does a findings-first review identify?▼

A findings-first review identifies bug risk, test coverage gaps, and documentation drift with precise file references. It analyzes code, tests, and architecture alignment to surface high-signal review findings before handoff.

How does this approach differ from manual documentation review?▼

Automated findings-first review reduces manual effort by systematically analyzing change sets against quality standards, identifying specific gaps and misalignments with file references, and enabling governance traceability across SDK/CLI changes without manual drift detection.