docs-writer

Synchronize README.md and CHANGELOG.md with agent-generated documentation.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/Oiranca/copilot-agents-skills --skill docs-writer-oiranca
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/Oiranca/copilot-agents-skills/tree/main/skills/docs-writer
Command: npx skills add https://github.com/Oiranca/copilot-agents-skills --skill docs-writer-oiranca

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill ensures that human-facing documentation like README and CHANGELOG stays up-to-date with the latest agent-generated documentation, preventing outdated information.

Core Features & Use Cases

  • Documentation Synchronization: Updates README.md and CHANGELOG.md based on new or changed agent-generated documentation.
  • Agent-Managed Sections: Intelligently updates specific sections in README.md using predefined markers, or appends new sections if markers are absent.
  • Changelog Management: Creates minimal, relevant entries in CHANGELOG.md for the current cycle.
  • Use Case: After an agent has updated architectural diagrams and decision logs, this skill can automatically summarize these changes into the README and add a brief note to the CHANGELOG.

Quick Start

Use the docs-writer skill to update the project's README and CHANGELOG files.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I synchronize my README with agent-generated documentation?

Documentation synchronization updates human-facing README.md files by integrating content from agent-generated sources like ARCHITECTURE.md and DECISIONS.md. It intelligently updates specific sections using predefined markers or appends new sections if markers are absent.

How does changelog management work for agent-managed documentation updates?

Changelog management creates minimal, relevant entries in CHANGELOG.md for the current cycle. It summarizes changes from agent-generated documentation sources into brief notes, ensuring the changelog stays current without manual intervention.

What's the best way to keep README content updated after an agent modifies architecture diagrams?

Keeping README content updated requires synchronizing human-facing documentation with agent-generated sources. After an agent updates architectural diagrams and decision logs, the skill automatically summarizes these changes into the README and adds a brief note to the CHANGELOG.

Can I use this skill to update README sections without losing existing content?

Updating README sections preserves existing content by adhering to strict read and write policies. The skill operates on agent-managed sections using predefined markers and avoids introducing undocumented features, ensuring original human-facing content remains intact.

What documentation sources are required for synchronizing human-facing documentation?

Synchronizing human-facing documentation operates on existing agent-generated sources like AGENT_STATE.json, STACK_PROFILE.md, INVENTORY.md, ARCHITECTURE.md, and DECISIONS.md. These files provide the updated information needed to reflect changes in README.md and CHANGELOG.md.

When do I need to synchronize documentation with agent-generated files?

Synchronizing documentation is needed when agent-generated files like DECISIONS.md or ARCHITECTURE.md are updated. It prevents outdated information by ensuring human-facing README and CHANGELOG files reflect the latest agent-managed documentation changes automatically.