Autonomous Documentation & Skill Synchronization Engine
This skill establishes the Zero-Reminder Automatic Synchronization Rule: whenever ANY code, API, database schema, workflow, or architecture change is introduced or modified in the repository, all corresponding architectural documents, API references, READMEs, changelogs, and AI agent skills (.agents/skills/) MUST be automatically inspected, updated, and expanded by the agent without requiring any prompting or reminders from the human user.
1. High-Priority Rule: Zero-Reminder Automatic Synchronization
[!IMPORTANT]
AUTONOMOUS DOCUMENTATION & SKILL UPDATES (No Human Prompting Needed):
- AI agents are strictly required to treat Agent Skills (
.agents/skills/) and Documentation (docs/, README.md, CHANGELOG.md) as first-class codebase artifacts.
- Every feature addition (
feat), improvement (perf/refactor), bug fix (fix), database migration (db), or DevOps pipeline (ci) MUST automatically trigger a synchronization pass across relevant skills and markdown specifications before finalizing commits.
- The human developer should NEVER have to ask: "please update the docs" or "please update the agent skills". This is a mandatory, automated built-in reflex.
2. Subsystem-to-Skill & Documentation Synchronization Matrix
Whenever modifying files in any subsystem, the agent MUST automatically update the corresponding documentation and skill files:
| Subsystem Modified |
Source Locations |
Required Documentation & Skill Updates |
| Git Workflow & Branching |
.githooks/, scripts/git-*.sh, .github/workflows/ |
• .agents/skills/git-commit-workflow/SKILL.md• .agents/skills/git-branch-management/SKILL.md• .agents/skills/git-post-merge-cleanup/SKILL.md• AGENTS.md• docs/PRECOMMIT_WORKFLOW.md• CHANGELOG.md |
| Database & Migrations |
backend/db/migrations/, agentic-observatory/data/migrations/, scripts/neon-*.sh |
• .agents/skills/repository-maintenance/SKILL.md• .agents/skills/github-backup-architecture/SKILL.md• docs/ARCHITECTURE.md• README.md (Migration Table)• CHANGELOG.md |
| AI Observatory & RAG |
agentic-observatory/agent/, agentic-observatory/data/tools/, agentic-observatory/utils/ |
• .agents/skills/agent-observatory-workflow/SKILL.md• docs/ARCHITECTURE.md• agentic-observatory/README.md• CHANGELOG.md |
| SaaS Connectors & BYO Storage |
backend/connectors/, backup-worker/storage/, agentic-observatory/connectors/ |
• .agents/skills/saas-and-mcp-architecture/SKILL.md• docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md• docs/ARCHITECTURE.md• CHANGELOG.md |
| Model Context Protocol (MCP) |
Native MCP Server, MCP tool handlers |
• .agents/skills/saas-and-mcp-architecture/SKILL.md• docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md• CHANGELOG.md |
| Go Backend & REST APIs |
backend/handlers/, backend/routes/, backend/models/ |
• docs/API_REFERENCE.md• docs/ARCHITECTURE.md• backend/README.md |
| CLI & Worker Engine |
backup-worker/main.go, backup-worker/service/, backup-worker/config/ |
• README.md• docs/ARCHITECTURE.md• backup-worker/README.md |
| Frontend & UI Dashboard |
frontend/src/app/, frontend/src/components/, frontend/src/services/ |
• README.md• CHANGELOG.md |
| CI/CD & Deployment |
.github/workflows/, *Dockerfile, render.yaml, *vercel.json |
• .agents/skills/ci-cd-workflow/SKILL.md• docs/DEPLOYMENT_GUIDE.md• README.md• CHANGELOG.md |
3. Autonomous Skill Creation & Evolution Rule
- When to Create a New Agent Skill (
.agents/skills/<name>/SKILL.md):
- Whenever introducing a new architectural pattern, operational domain, or subsystem that future AI agents must interact with or maintain (e.g.
saas-and-mcp-architecture, git-post-merge-cleanup, cli-tooling-guide).
- Format: Include YAML frontmatter (
name, description) and comprehensive operational guidelines, rules, and example commands.
- When to Update Existing Skills:
- Whenever modifying runtime behaviors, adding flags to scripts, updating CLI commands, or changing deployment configurations.
- Keep skills concise, actionable, and strictly synchronized with the live implementation.
4. Pre-Commit Autonomous Synchronization Checklist
Before executing git commit or finalizing any milestone, execute this 4-step checklist:
- Inspect Staged/Modified Files:
git status --short
- Cross-Reference Subsystem Matrix: Identify all target docs and agent skills impacted by the modified files.
- Apply Documentation & Skill Edits: Update markdown files and skills with exact details.
- Log in Changelog: Add concise bullet points under
## [Unreleased] in CHANGELOG.md.
- Sync Skills Upstream: If any skill inside
.agents/skills/ was added or modified, execute skills-sync push (or make skills-push) to propagate updates to MishraShardendu22/agent-skills.
1---2name: doc-synchronization3description: High-priority rules and automated procedures for continuously keeping repository documentation, API references, architecture guides, changelogs, and agent skills synchronized with code changes autonomously without requiring human reminders.4---56# Autonomous Documentation & Skill Synchronization Engine78This skill establishes the **Zero-Reminder Automatic Synchronization Rule**: whenever ANY code, API, database schema, workflow, or architecture change is introduced or modified in the repository, all corresponding architectural documents, API references, READMEs, changelogs, and AI agent skills (`.agents/skills/`) MUST be automatically inspected, updated, and expanded by the agent **without requiring any prompting or reminders from the human user**.910---1112## 1. High-Priority Rule: Zero-Reminder Automatic Synchronization1314> [!IMPORTANT]15> **AUTONOMOUS DOCUMENTATION & SKILL UPDATES (No Human Prompting Needed)**:16> * AI agents are strictly required to treat **Agent Skills (`.agents/skills/`)** and **Documentation (`docs/`, `README.md`, `CHANGELOG.md`)** as first-class codebase artifacts.17> * Every feature addition (`feat`), improvement (`perf`/`refactor`), bug fix (`fix`), database migration (`db`), or DevOps pipeline (`ci`) MUST automatically trigger a synchronization pass across relevant skills and markdown specifications before finalizing commits.18> * The human developer should **NEVER** have to ask: *"please update the docs"* or *"please update the agent skills"*. This is a mandatory, automated built-in reflex.1920---2122## 2. Subsystem-to-Skill & Documentation Synchronization Matrix2324Whenever modifying files in any subsystem, the agent MUST automatically update the corresponding documentation and skill files:2526| Subsystem Modified | Source Locations | Required Documentation & Skill Updates |27| :--- | :--- | :--- |28| **Git Workflow & Branching** | `.githooks/`, `scripts/git-*.sh`, `.github/workflows/` | • [`.agents/skills/git-commit-workflow/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/git-commit-workflow/SKILL.md)<br>• [`.agents/skills/git-branch-management/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/git-branch-management/SKILL.md)<br>• [`.agents/skills/git-post-merge-cleanup/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/git-post-merge-cleanup/SKILL.md)<br>• [`AGENTS.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/AGENTS.md)<br>• [`docs/PRECOMMIT_WORKFLOW.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/PRECOMMIT_WORKFLOW.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |29| **Database & Migrations** | `backend/db/migrations/`, `agentic-observatory/data/migrations/`, `scripts/neon-*.sh` | • [`.agents/skills/repository-maintenance/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/repository-maintenance/SKILL.md)<br>• [`.agents/skills/github-backup-architecture/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/github-backup-architecture/SKILL.md)<br>• [`docs/ARCHITECTURE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/ARCHITECTURE.md)<br>• [`README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/README.md) (Migration Table)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |30| **AI Observatory & RAG** | `agentic-observatory/agent/`, `agentic-observatory/data/tools/`, `agentic-observatory/utils/` | • [`.agents/skills/agent-observatory-workflow/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/agent-observatory-workflow/SKILL.md)<br>• [`docs/ARCHITECTURE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/ARCHITECTURE.md)<br>• [`agentic-observatory/README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/agentic-observatory/README.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |31| **SaaS Connectors & BYO Storage** | `backend/connectors/`, `backup-worker/storage/`, `agentic-observatory/connectors/` | • [`.agents/skills/saas-and-mcp-architecture/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/saas-and-mcp-architecture/SKILL.md)<br>• [`docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md)<br>• [`docs/ARCHITECTURE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/ARCHITECTURE.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |32| **Model Context Protocol (MCP)** | Native MCP Server, MCP tool handlers | • [`.agents/skills/saas-and-mcp-architecture/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/saas-and-mcp-architecture/SKILL.md)<br>• [`docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/SAAS_ARCHITECTURE_AND_MCP_ROADMAP.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |33| **Go Backend & REST APIs** | `backend/handlers/`, `backend/routes/`, `backend/models/` | • [`docs/API_REFERENCE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/API_REFERENCE.md)<br>• [`docs/ARCHITECTURE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/ARCHITECTURE.md)<br>• [`backend/README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/backend/README.md) |34| **CLI & Worker Engine** | `backup-worker/main.go`, `backup-worker/service/`, `backup-worker/config/` | • [`README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/README.md)<br>• [`docs/ARCHITECTURE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/ARCHITECTURE.md)<br>• [`backup-worker/README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/backup-worker/README.md) |35| **Frontend & UI Dashboard** | `frontend/src/app/`, `frontend/src/components/`, `frontend/src/services/` | • [`README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/README.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |36| **CI/CD & Deployment** | `.github/workflows/`, `*Dockerfile`, `render.yaml`, `*vercel.json` | • [`.agents/skills/ci-cd-workflow/SKILL.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/.agents/skills/ci-cd-workflow/SKILL.md)<br>• [`docs/DEPLOYMENT_GUIDE.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/docs/DEPLOYMENT_GUIDE.md)<br>• [`README.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/README.md)<br>• [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md) |3738---3940## 3. Autonomous Skill Creation & Evolution Rule4142* **When to Create a New Agent Skill (`.agents/skills/<name>/SKILL.md`)**:43 * Whenever introducing a new architectural pattern, operational domain, or subsystem that future AI agents must interact with or maintain (e.g. `saas-and-mcp-architecture`, `git-post-merge-cleanup`, `cli-tooling-guide`).44 * Format: Include YAML frontmatter (`name`, `description`) and comprehensive operational guidelines, rules, and example commands.45* **When to Update Existing Skills**:46 * Whenever modifying runtime behaviors, adding flags to scripts, updating CLI commands, or changing deployment configurations.47 * Keep skills concise, actionable, and strictly synchronized with the live implementation.4849---5051## 4. Pre-Commit Autonomous Synchronization Checklist5253Before executing `git commit` or finalizing any milestone, execute this 4-step checklist:54551. **Inspect Staged/Modified Files**:56 ```bash57 git status --short58 ```592. **Cross-Reference Subsystem Matrix**: Identify all target docs and agent skills impacted by the modified files.603. **Apply Documentation & Skill Edits**: Update markdown files and skills with exact details.614. **Log in Changelog**: Add concise bullet points under `## [Unreleased]` in [`CHANGELOG.md`](file:///home/ms22/Coding_stuff/Personal-Projects/github-backup-automation-system/CHANGELOG.md).625. **Sync Skills Upstream**: If any skill inside `.agents/skills/` was added or modified, execute `skills-sync push` (or `make skills-push`) to propagate updates to `MishraShardendu22/agent-skills`.63