← 返回 Skills 市场
doc-sync
作者
shangter666
· GitHub ↗
· v1.0.0
· MIT-0
212
总下载
0
收藏
0
当前安装
1
版本数
在 OpenClaw 中安装
/install doc-sync
功能描述
Context-Aware Doc Generator: Automatically syncs Python docstrings (Google style), Go comments, and README.md based on code changes. Also logs change summari...
使用说明 (SKILL.md)
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, andAttributes. - 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.
How to trigger: "Update README.md based on the latest changes in [directory/file]."
3. Knowledge Base (KB) Sync
For major code changes, this skill generates a concise summary of "why" the change was made and stores it for future retrieval.
- Uses
scripts/kb_sync.pyto interface with a local ChromaDB (if available) or log to.gemini/changelog.jsonl. - Ensures you can later query the project's history via CLI.
How to trigger: "Log this change to the knowledge base" or "Summarize my changes and sync to KB."
Reference Materials
- Doc Styles: Detailed examples of Google and Go documentation styles.
Usage Guidelines
- Always review suggested docstring changes before applying.
- For README updates, provide the specific section title if possible.
- Ensure
chromadbis installed if you want vector-based retrieval; otherwise, it defaults to a local JSONL log.
安全使用建议
This package overclaims functionality: it promises automatic docstring and README updates but only includes a script to log change summaries to a local KB and a doc-style reference. Before installing or invoking: (1) treat the skill as incomplete — verify where and how doc/README edits would be produced (ask the author for the editing implementation or additional scripts). (2) Because the skill can write to .gemini/, run it first in a disposable or version-controlled repo and ensure you have backups/commits you can revert. (3) If you want automatic file edits, require explicit human review/approval steps (or CI-based changes) rather than blind writes. (4) If you need vector-based KB storage, be aware it will look for a local ChromaDB and persist under ./ .gemini/kb; installing chromadb is optional. Additional information that would change this assessment: included code that actually performs docstring/README edits (showing what files are modified and how), any install scripts, or any network endpoints/credentials — those would need re-review.
功能分析
Type: OpenClaw Skill
Name: doc-sync
Version: 1.0.0
The skill bundle is a legitimate documentation synchronization tool that updates docstrings and README files. The script `scripts/kb_sync.py` implements local logging and vector storage using ChromaDB in a local directory (./.gemini/kb), with no evidence of data exfiltration, malicious execution, or unauthorized access.
能力评估
Purpose & Capability
The skill's name/description promise automatic synchronization of Python docstrings, Go comments, and README.md, but the bundled files contain only a KB sync script (scripts/kb_sync.py) and reference materials. There is no provided implementation for parsing or modifying source files or README sections. That is a meaningful mismatch between claimed capability and included artifacts.
Instruction Scope
SKILL.md instructs the agent to update docstrings and README.md and to log change summaries using scripts/kb_sync.py. The KB logging script exists and writes locally, which matches that part of the instructions, but the instructions otherwise assume the agent can modify code/comments/README — there is no code or explicit safe workflow for performing those edits or for seeking user approval before applying changes.
Install Mechanism
No install specification is provided (instruction-only with one helper script). No external downloads or installers are indicated, so nothing new would be written to disk by an installer step beyond the script already bundled.
Credentials
The skill declares no required environment variables, no credentials, and no config paths. The included script optionally imports chromadb if installed but does not require secrets or network endpoints. The only filesystem impact is writing to a local .gemini directory.
Persistence & Privilege
always is false and model invocation is allowed (default). The skill will persist local artifacts (.gemini/kb or .gemini/changelog.jsonl) if used, but it does not request elevated or cross-skill privileges.
如何使用
- 确保已安装 OpenClaw（本地或 Docker 部署）
- 在对话框中输入安装命令：
/install doc-sync - 安装完成后，直接呼叫该 Skill 的名称或使用
/doc-sync触发 - 根据 Skill 的参数说明提供必要输入，即可获得结构化输出
版本历史
v1.0.0
- Initial release of doc-sync.
- Automatically updates Python docstrings (Google style) and Go comments to reflect code changes.
- Keeps README.md in sync with new or changed APIs, CLI flags, or endpoints.
- Logs concise change summaries to a local knowledge base (ChromaDB or JSONL).
- Supports clear commands to trigger documentation and knowledge base updates.
元数据
常见问题
doc-sync 是什么？
Context-Aware Doc Generator: Automatically syncs Python docstrings (Google style), Go comments, and README.md based on code changes. Also logs change summari... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 212 次。
如何安装 doc-sync？
在 OpenClaw 或 Claude Code 对话框中运行命令「/install doc-sync」即可一键安装，无需额外配置。
doc-sync 是免费的吗？
是的，doc-sync 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。
doc-sync 支持哪些平台？
doc-sync 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。
谁开发了 doc-sync？
由 shangter666（@shangter666）开发并维护，当前版本 v1.0.0。
推荐 Skills