ada-docs-revision

Revises technical documents through audit, proposal, ordered replacement, and grep-based verification.

Updated Jul 23, 2026
One-click install
npx skills add https://github.com/wubing7755/Ada --skill ada-docs-revision-wubing7755
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ada-docs-revision
Source: https://github.com/wubing7755/Ada/tree/main/skills/software-development/ada-docs-revision
Command: npx skills add https://github.com/wubing7755/Ada --skill ada-docs-revision-wubing7755

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Large-scale terminology changes in technical documents (SRS, design docs, API specs) are error-prone: missed occurrences, corrupted mermaid diagrams, broken markdown tables, and inconsistent Chinese-English mixed terms. This Skill provides a controlled five-phase workflow that audits every occurrence first, grounds proposals in real-world product references, requires explicit approval before edits, and verifies results with grep checks. ## Core Features & Use Cases - Five-phase revision workflow: Audit with multi-pattern grep, reference canonical products (VS Code, JetBrains Rider), propose a BEFORE/AFTER mapping table, execute replacements in dependency order, and verify zero-count of old terms. - Breakage recovery patterns: Detects and repairs replace_all corruption of mermaid ER diagrams (||--o{), falls back to line-targeted sed when the patch tool fails on SVG text with escaped quotes, and cleans up double-space artifacts after replacement. - Use Case: You need to rename "Dock 区域" to "停靠区" across a 2000-line design document. The Skill maps all occurrences, proposes a terminology table aligned with VS Code conventions, waits for your approval, then executes replacements from longest compound phrases to standalone terms and confirms old terms are gone. ## Quick Start Ask the agent to audit and rename a term across your markdown document, for example: "Replace all occurrences of 'Dock Panel' with 'Panel' in design.md and show me the mapping table before making changes."

Frequently Asked Questions about ada-docs-revision

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

FAQPage Schema
How do I rename a term across a large markdown document safely?

Audit all occurrences first with grep -n using multiple patterns, then present a BEFORE/AFTER mapping table for approval. Execute replacements in dependency order: specific compound phrases first, standalone terms next, then entity names, and verify old terms reach zero count.

What is the correct order for batch terminology replacement in documents?

Replace longest specific phrases first, then standalone terms with replace_all, followed by compound terms, entity or area names, abbreviation cleanup, and finally spacing fixes. Verify no corruption after each step before proceeding.

Why does replace_all corrupt mermaid ER diagrams in markdown?

Mermaid ER diagrams use ||--o{ and ||--|| symbols, so a replace_all of || to | breaks relationship notation. After any replace_all, grep for |--o{ or |--|| and restore corrupted lines with a patch anchored on the erDiagram context.

How do I edit SVG text when the patch tool fails on escaped quotes?

Fall back to sed with exact line numbers, such as sed -i '511s/old/new/' doc.md, then verify with sed -n '511p'. Escaped quotes in blockquote-prefixed SVG lines cause matching ambiguity for patch tools.

When should I use ada-docs-revision versus ada-srs-revision?

Use ada-docs-revision for general technical documents like design docs, API specs, and READMEs. Use ada-srs-revision for SRS-specific work involving requirement numbering, traceability, data models, and the full SRS lifecycle dependency order.