documentation-writer

Apply diff-based documentation updates to docs/ and root README during PR workflows.

15|3|Updated Apr 9, 2026
One-click install
npx skills add https://github.com/LazyIsEfficient/agentic-os --skill documentation-writer-lazyisefficient
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/LazyIsEfficient/agentic-os/tree/main/.claude/skills/documentation-writer
Command: npx skills add https://github.com/LazyIsEfficient/agentic-os --skill documentation-writer-lazyisefficient

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Keeps repository documentation accurate by applying incremental, diff-based updates to docs/ and root README when navigation requires it, ensuring documentation reflects the current codebase.

Core Features & Use Cases

  • Diff-first updates: compute changes relative to the PR base and apply only documentation-related edits.
  • Scope confinement: edits stay inside docs/ (and root README when necessary for navigation) to avoid churn in non-documentation files.
  • Validation and idempotency: verify changes before writing and ensure repeated runs produce no additional changes.
  • Scoped commits: generate a single, docs-only commit per update, with a focused message and minimal churn.

Quick Start

Compute the PR diff against the base and apply incremental, docs-only updates inside docs/ (or root README when navigation requires it).

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I automate documentation updates inside a pull request?

To automate documentation updates in a pull request, this Skill computes the diff against the PR merge-base and applies incremental, docs-only edits to synchronize changes. It generates a single, idempotent commit restricted to documentation files.

What is diff-based documentation synchronization?

Diff-based documentation synchronization computes code changes relative to the PR base and applies only the necessary documentation-related edits. This ensures repository docs accurately reflect the current codebase without modifying non-documentation files.

How do I keep Mermaid diagrams and README files in sync with code changes?

To keep Mermaid diagrams and README files in sync, this Skill applies diff-based updates during PR workflows. It restricts edits to docs/, root README, and diagram assets, ensuring documentation reflects the latest codebase changes.

Does this documentation update tool modify source code files?

No, this documentation update tool does not modify source code files. It enforces scope confinement by restricting all edits to the docs/ directory and root README, preventing churn in non-documentation files.

What's the best way to prevent duplicate documentation commits in CI?

The best way to prevent duplicate documentation commits is using idempotent validation. This Skill verifies changes before writing and ensures repeated runs produce no additional commits, outputting a single docs-only commit per update.

Can I use this for updating docs outside the docs directory?

You can only update docs outside the docs/ directory if it is the root README file. The Skill confines all other documentation updates strictly to the docs/ folder to avoid unnecessary file churn.