docs-writer

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

Updated Apr 11, 2026

Search Tags:#documentation #markdown #AI #repository #APEX

Ready to run

npx skills add https://github.com/jgezelscorp/Apex --skill docs-writer-jgezelscorp

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/jgezelscorp/Apex/tree/main/.github/skills/docs-writer
Command: npx skills add https://github.com/jgezelscorp/Apex --skill docs-writer-jgezelscorp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your repository documentation is always accurate, fresh, and consistent, saving you time and effort in maintaining and updating it.

Core Features & Use Cases

Documentation Updates: Automates the updating of existing documentation with the latest changes.
New Entity Documentation: Adds documentation for new agents or skills to the repository.
Freshness Audit: Checks for outdated information and proposes fixes.
Repo Explanation: Provides explanations of the repository architecture and components.
Changelog Entry Generation: Automatically generates changelog entries from commit history.
Proofreading: Reviews documentation for language, tone, and technical accuracy.

Quick Start

Use the docs-writer skill to update the documentation for the 'Orchestrator' agent.

Frequently Asked Questions about docs-writer

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

FAQPage Schema

How do I automate repository documentation updates for new agents and skills?▼

To automate repository documentation updates, you maintain markdown files for new agents or skills, ensuring freshness and consistency. This checks for outdated information and proposes fixes to keep technical documentation accurate.

What is the best way to generate changelog entries from commit history?▼

Generating changelog entries from commit history analyzes recent commits to automatically produce markdown summaries. This keeps repository documentation up-to-date without manually tracking every code change or architectural update.

Does the documentation writer work with markdown files outside of agent-output?▼

The documentation writer operates on markdown files within the repository but explicitly excludes agent-output files. It focuses on keeping standard documentation accurate, fresh, and consistent across the codebase.

How do I check for stale or outdated information in repository documentation?▼

Checking for outdated information in repository documentation involves performing a freshness audit. This identifies stale content, proposes fixes, and reviews language, tone, and technical accuracy to maintain consistency.

Can I get an explanation of my repository architecture and components?▼

You can get an explanation of your repository architecture and components by requesting a repo explanation. This reviews markdown documentation to provide accurate summaries of how the repository is structured.