doc-edit

Update existing project documents with minimal version-controlled edits.

1|Updated Feb 1, 2026
One-click install
npx skills add https://github.com/becky3/ai-assistant --skill doc-edit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-edit
Source: https://github.com/becky3/ai-assistant/tree/main/.claude/skills/doc-edit
Command: npx skills add https://github.com/becky3/ai-assistant --skill doc-edit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill updates existing project documents safely while preserving file structure and ensuring change traceability.

Core Features & Use Cases

  • Safe in-place edits that preserve formatting and structure while applying updates to specs, CLAUDE guidelines, and retro notes.
  • Change-justification and minimal diff edits to keep history clean and reviewable.
  • Use Case: When a specification (docs/specs) changes, update the related documentation to reflect the new criteria and rationale.

Quick Start

/doc-edit docs/specs/overview.md "Reflect updated acceptance criteria"

Frequently Asked Questions about doc-edit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I safely edit repository documentation without breaking file structure?

To safely edit repository documentation without breaking file structure, read the target file before writing and apply minimal targeted edits. This preserves formatting and ensures version-controlled changes remain traceable.

What's the best way to update project specs and keep version control history clean?

The best way to update project specs and keep version control history clean is applying minimal diff edits with change justification. This approach ensures documentation updates remain reviewable and traceable across the repository.

Can I update CLAUDE guidelines and retro notes in place within a repository?

Yes, you can update CLAUDE guidelines and retro notes in place within a repository. The process enforces a read-before-write workflow using argument parsing to apply safe, targeted edits while preserving existing formatting.

How does a read-before-write workflow improve documentation editing?

A read-before-write workflow improves documentation editing by enforcing argument parsing and minimal targeted edits before modifying files. This mechanism ensures change traceability and prevents accidental formatting loss in repository documents.

When do I need to use minimal diff edits for repository docs?

You need to use minimal diff edits for repository docs when specifications change and related documentation must reflect new acceptance criteria. This keeps history clean, reviewable, and preserves the original file structure.

Does version-controlled documentation editing support historical accuracy updates?

Version-controlled documentation editing supports historical accuracy updates by applying targeted in-place edits to existing project documents. It handles documentation clarifications and spec changes while preserving formatting and ensuring traceable repository modifications.