document-update — keeping rust docs up-to-date document-update, typing_engine, community, keeping rust docs up-to-date, ide skills, rust documentation workflow, document-update install, rust code commenting, Claude Code, Cursor, Windsurf

v1.0.0
GitHub

About this Skill

Perfect for Code Maintenance Agents needing automated Rust documentation updates. document-update is a library crate for maintaining accurate and consistent Rust documentation, ensuring that comments and code remain in sync.

Features

Updates Rust doc comments to reflect current code
Supports synchronization of non-doc comments with code changes
Automatically updates README files to ensure consistency
Identifies and addresses out-of-sync files, including Rust modules and public types/functions
Treats current code as the source of truth, preventing unnecessary changes

# Core Topics

keeping rust docs up-to-date rust documentation workflow document-update install rust code commenting
Kotaro7750 Kotaro7750
[0]
[0]
Updated: 1/19/2026

Agent Capability Analysis

The document-update skill by Kotaro7750 is an open-source community AI agent skill for Claude Code and other IDE workflows, helping agents execute tasks with better context, repeatability, and domain-specific guidance. Optimized for keeping rust docs up-to-date, rust documentation workflow, document-update install.

Ideal Agent Persona

Perfect for Code Maintenance Agents needing automated Rust documentation updates.

Core Value

Empowers agents to keep Rust documentation aligned with current code by updating doc comments, non-doc comments, and README files, ensuring consistency without changing behavior or APIs, and supporting Rust modules, public types, and functions.

↓ Capabilities Granted for document-update

Updating Rust doc comments for public types and functions
Synchronizing README files with current codebase
Maintaining consistency between code and documentation for Rust modules

! Prerequisites & Limits

  • Limited to Rust programming language
  • Does not modify code, only updates documentation
  • Requires identification of files changed or out of sync
Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

document-update

Install document-update, an AI agent skill for AI agent workflows and automation. Works with Claude Code, Cursor, and Windsurf with one-command setup.

SKILL.md
Readonly

Document Update

Overview

Keep docs and comments aligned with the current code by updating Rust doc comments, non-doc comments, and README without changing behavior or APIs.

Workflow

1) Establish scope and sources of truth

  • Identify which files changed or are likely out of sync (Rust modules, public types/functions, README).
  • Treat current code as the source of truth; do not change code while updating docs.
  • If doc changes imply code changes are needed, stop and ask.

2) Read existing tone and structure

  • Read the local section/module/file to match tone, language, and formatting.
  • If the file mixes languages, prefer the surrounding section’s language.
  • Keep README concise; do not inflate with speculative content.

3) Update Rust doc comments

  • Module-level //!: Describe the module’s role, then explain relationships and differences between its major symbols (types/functions/modules) and how they fit together.
  • Item-level ///: Explain design intent, invariants, constraints, tradeoffs, and non-obvious behavior. Avoid repeating obvious names, fields, or signatures.
  • Add/adjust examples only when they clarify non-obvious usage or invariants.

4) Update non-doc comments (//, /* */)

  • Use comments for rationale and high-level flow of complex logic.
  • Avoid restating line-by-line behavior; prefer intent and “why.”
  • Remove or rewrite comments that are now misleading or redundant.

5) Update README

  • Ensure summary, usage pointers, and examples align with current API and behavior.
  • Keep the README brief; link to docs.rs or other references when appropriate.

6) Final consistency check

  • No code changes.
  • No stale terminology or outdated file/module names.
  • Comments do not contradict each other or the code.

Quality Checklist

  • Doc comments explain intent and invariants, not just “what.”
  • Module docs explain relationships/differences between key symbols.
  • Non-doc comments describe rationale or flow for complex sections.
  • README aligns with current public API and behavior.
  • Language and tone match the existing file.

References

  • references/doc-style.md for project-specific tone and conventions.

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is document-update?

Perfect for Code Maintenance Agents needing automated Rust documentation updates. document-update is a library crate for maintaining accurate and consistent Rust documentation, ensuring that comments and code remain in sync.

How do I install document-update?

Run the command: npx killer-skills add Kotaro7750/typing_engine/document-update. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for document-update?

Key use cases include: Updating Rust doc comments for public types and functions, Synchronizing README files with current codebase, Maintaining consistency between code and documentation for Rust modules.

Which IDEs are compatible with document-update?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for document-update?

Limited to Rust programming language. Does not modify code, only updates documentation. Requires identification of files changed or out of sync.

↓ How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add Kotaro7750/typing_engine/document-update. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use document-update immediately in the current project.

Related Skills

Looking for an alternative to document-update or another community skill for your workflow? Explore these related open-source skills.

View All

widget-generator

Logo of f
f

f.k.a. Awesome ChatGPT Prompts. Share, discover, and collect prompts from the community. Free and open source — self-host for your organization with complete privacy.

★ 149.6k
⑂ 0
AI

flags

Logo of vercel
vercel

flags is a Next.js feature management skill that enables developers to efficiently add or modify framework feature flags, streamlining React application development.

★ 138.4k
⑂ 0
Browser

zustand

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI

data-fetching

Logo of lobehub
lobehub

The ultimate space for work and life — to find, build, and collaborate with agent teammates that grow with you. We are taking agent harness to the next level — enabling multi-agent collaboration, effortless agent team design, and introducing agents as the unit of work interaction.

★ 72.8k
⑂ 0
AI