docs-writer

Audit and update repository Markdown documentation for accuracy and freshness.

Updated Apr 21, 2026
One-click install
npx skills add https://github.com/cassm199-mita/azure-agentic-infraops-accelerator --skill docs-writer-cassm199-mita
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/cassm199-mita/azure-agentic-infraops-accelerator/tree/main/.github/skills/docs-writer
Command: npx skills add https://github.com/cassm199-mita/azure-agentic-infraops-accelerator --skill docs-writer-cassm199-mita

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires doc-standards, f Freshness Checklist, repo-architecture, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Ensures that all markdown documentation within the repository is up-to-date, accurate, and consistent, streamlining the process of managing and updating documentation.

Core Features & Use Cases

  • Documentation Accuracy: Checks and corrects inaccuracies and outdated information in all markdown documentation.
  • Freshness Audits: Runs checks for freshness in all in-scope documentation, including links, version numbers, and resource counts.
  • Automation Workflows: Automated processes to update and correct issues without manual intervention, saving time and reducing errors.
  • Use Case: When you need to ensure that your project's documentation is synchronized with the latest changes in the codebase.

Quick Start

Trigger the docs-writer skill with the command: "Update the docs."

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I check markdown documentation freshness and accuracy in a repository?

Documentation freshness is maintained by running automated audits that check markdown files for outdated links, incorrect version numbers, and stale resource counts. The tool corrects inaccuracies and synchronizes docs with codebase changes.

What is the best way to automate markdown documentation maintenance?

Automating markdown documentation maintenance involves triggering workflows that update and correct issues without manual intervention. This streamlined process ensures consistency, compliance with standards, and reduces manual update errors.

How do I keep repository documentation synchronized with codebase changes?

Repository documentation is synchronized with codebase changes by running a single command that updates docs, checks for staleness, and generates changelogs. This ensures all markdown files reflect the latest architectural modifications.

Does documentation maintenance require local tools for markdown formatting and version checks?

Yes, local tools for markdown formatting, linking, and version checks are required. These dependencies support the automation workflows that validate documentation standards and ensure repository architecture explanations remain accurate.

Can I use this to generate changelogs and repository architecture explanations?

Yes, generating changelogs and repository architecture explanations are supported use cases. The tool maintains documentation accuracy across these formats while ensuring compliance with established documentation standards.

What are the limitations of automating documentation accuracy checks?

Automated documentation accuracy checks require local tools for markdown formatting and linking to function properly. The tool is limited to managing markdown files and cannot update documentation formats outside of the specified repository scope.