askill
documentation-sync

documentation-syncSafety 85Repository

Ensure that project documentation (README, API specs, /doc folder) remains in sync with the actual implementation. Trigger after major refactors or when adding new features.

0 stars
1.2k downloads
Updated 2/8/2026

Package Files

Loading files...
SKILL.md

Documentation Sync

Intent

Automatically triggered or manually requested to verify that the README.md, docs/, and OPENAPI specs match the current codebase.

Checklist

  1. README Consistency: Check if the "Getting Started" or "Architecture" sections in README.md are still accurate after recent changes.
  2. API Alignment: Verify that FastAPI routes in backend/main.py match descriptions in docs/API.md (if exists).
  3. Plan Updates: If a task in plan/ is completed, ensure the implementation details are reflected in the final documentation.
  4. Environment Variables: Check if new .env variables have been added to README.md or .env.example.

Output Format

Documentation Status

  • Files Checked: list of files
  • Sync Issues:
    • [File]: [What is missing or outdated]
  • Suggested Updates:
    • [Snippet of updated documentation]

Install

Download ZIP
Requires askill CLI v1.0+

AI Quality Score

53/100Analyzed 2/18/2026

A basic documentation sync skill with a clear intent and checklist structure but lacking actionable details. The checklist provides 4 areas to check (README, API, plans, env vars) but doesn't specify how to actually perform these checks—no commands, tools, or step-by-step procedures. The output format is defined but feels template-like without connection to real workflow. Safe to use (read-only) but would need significant enhancement to be practically useful.

85
55
50
45
35

Metadata

Licenseunknown
Version-
Updated2/8/2026
Publisherluxunxiansheng

Tags

api