doc-sync

A skill for maintaining strong consistency between code, documentation, and a private knowledge base.

Workflows

1. Synchronize Docstrings and Comments

When you modify function logic or signatures in Python or Go, use this skill to update the relevant comments.

• Python: Follows Google Style. Updates Args, Returns, and Attributes.
• Go: Follows Standard Go Doc style. Updates exported function/struct comments.

How to trigger: "Update docstrings for [file_path]" or "Sync comments in [file_path] after my changes."

2. README.md Real-time Update

When adding new exported functions, CLI flags, or API endpoints, this skill ensures the root README.md is updated to reflect the new interface.

• Scans for changes in public APIs.
• Updates "Usage" or "API Reference" sections in README.md.