skills.rest
pazdedav
pazdedavCOMMUNITY
Explore all skills by this author →
Website𝕏@pazdedavGitHub

docs-writer

Update markdown documentation and generate changelog entries from Git history.

Updated Mar 9, 2026
Search Tags:#changelog#documentation#maintenance#docs#accuracy#freshness
One-click install
npx skills add https://github.com/pazdedav/my-infraops-project --skill docs-writer-pazdedav
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/pazdedav/my-infraops-project/tree/main/.github/skills/docs-writer
Command: npx skills add https://github.com/pazdedav/my-infraops-project --skill docs-writer-pazdedav

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 documentation for agents/skills, and checks for staleness.
  • Content Quality: Proofreads for language, tone, and technical accuracy.
  • Changelog Generation: Creates changelog entries from Git history.
  • Use Case: After adding a new agent, use this Skill to automatically generate its documentation, update relevant tables in the README, and ensure all links are still valid.

Quick Start

Use the docs-writer skill to check the documentation for staleness.

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 fresh after codebase changes?▼

To keep repository documentation accurate and fresh, you can update existing markdown files and add new entity documentation. This process ensures your repository docs remain consistent with the codebase, preventing outdated information and improving user understanding.

How do I generate changelog entries from Git history for my project?▼

Generating changelog entries from Git history is performed by analyzing repository commits to automatically create accurate documentation updates. This creates consistent changelog records within your markdown files based on recent development changes.

What is the best way to check markdown documentation for staleness?▼

Checking markdown documentation for staleness involves scanning files within specified directories to identify outdated information. This staleness check includes an auto-fixing mechanism to update content and ensure technical accuracy.

Can I automatically document new agents and update README tables?▼

Yes, you can automatically document new agents and update relevant README tables. This ensures that new entities are properly recorded and all internal links within your repository architecture remain valid.

Does this documentation maintenance process require specific internal standards?▼

Yes, this documentation maintenance process references internal standards and architecture documents for consistency and accuracy. It operates on markdown files within specified directories to align all updates with your established repository guidelines.

Related Skills

Explore More Content & Communication Skills→
pulumipulumi
178

move-doc

Move documentation files with git mv and update Hugo aliases and links.

Official
Advanced
batuhanysvbatuhanysv

docs-writer

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

Community
Intermediate
stravineststravinest

codebase-update

Update .codebase documentation to reflect recent code changes.

Community
Basic
jgezelscorpjgezelscorp

docs-writer

Update markdown documentation and generate changelog entries in the APEX repository.

Community
Advanced