docs-writer

Update repository markdown documentation and generate changelog entries from Git history.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/batuhanysv/sdx-agentic-infraops --skill docs-writer-batuhanysv
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/batuhanysv/sdx-agentic-infraops/tree/main/.github/skills/docs-writer
Command: npx skills add https://github.com/batuhanysv/sdx-agentic-infraops --skill docs-writer-batuhanysv

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures your repository's documentation remains accurate, up-to-date, and consistent with the codebase, preventing outdated information and improving user understanding.

Core Features & Use Cases

  • Documentation Maintenance: Updates existing docs, adds new entity documentation, and checks for staleness.
  • Quality Assurance: Proofreads documentation for language, tone, and technical accuracy.
  • Changelog Generation: Creates changelog entries based on Git history.
  • Use Case: When you add a new agent or skill, use this Skill to automatically update the relevant tables in the README and other documentation files, ensuring the project's documentation accurately reflects its current state.

Quick Start

Use the docs-writer skill to update the repository documentation for the new 'azure-data-explorer' skill.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I keep repository documentation accurate and up-to-date with codebase changes?

To keep repository documentation accurate, you can update existing markdown files, add new entity documentation, and perform staleness checks to ensure technical writing matches the current codebase state.

How do I generate changelog entries from git history for repository maintenance?

Generating changelog entries involves analyzing git history to automatically create markdown summaries of codebase updates, ensuring repository maintenance records reflect recent project changes accurately.

What's the best way to update README tables when adding new entities to a repository?

The best way to update README tables is to automatically modify the relevant markdown structures, adding new entity documentation to ensure the project documentation accurately reflects the newly added components.

Can I proofread technical writing for language and technical accuracy in markdown files?

Yes, you can proofread technical writing in markdown files to verify language consistency, tone, and technical accuracy, ensuring repository documentation maintains high quality and standards.

How do I check for documentation staleness in a code repository?

Checking documentation staleness involves scanning markdown files to identify outdated information, verifying that existing technical writing remains consistent with the current repository architecture and codebase.

Does the docs-writer skill explain repository architecture using markdown?

Yes, the docs-writer skill explains repository architecture by referencing specific instruction and reference files to generate accurate technical documentation within markdown files.