docs-writer

Review and edit markdown documentation to match repository-specific conventions.

Updated Apr 7, 2026
One-click install
npx skills add https://github.com/voidreader/band-of-mercenaries --skill docs-writer-voidreader
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/voidreader/band-of-mercenaries/tree/main/.agents/skills/docs-writer
Command: npx skills add https://github.com/voidreader/band-of-mercenaries --skill docs-writer-voidreader

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you write, revise, and review project documentation with a consistent technical tone, accurate terminology, and the correct repository-specific style.

Core Features & Use Cases

  • Document authoring: Create new markdown pages that follow the project's documentation conventions and structure.
  • Document editing: Update existing documentation so it reflects current implementation details, naming, and workflow rules.
  • Document review: Check readability, formatting, completeness, and consistency across README files and Docs directory content.
  • Use case: Use this Skill when a feature change requires updating setup instructions, design notes, release notes, or any other markdown-based project documentation.

Quick Start

Ask the docs-writer skill to review the target markdown file and rewrite it so it matches the repository's documentation standards.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I update project documentation to match current codebase behavior?

To update project documentation, review existing markdown files and rewrite them to align with current implementation details, naming conventions, and workflow rules. This ensures documentation accurately reflects the active codebase behavior and repository-specific standards.

What is the best way to maintain consistent technical writing style across README files?

Maintaining consistent technical writing style across README files requires applying a standardized style guide to review and edit content. This process checks readability, formatting, and terminology consistency to ensure all markdown-based knowledge assets match project conventions.

How do I check markdown documentation for formatting and link consistency?

Checking markdown documentation for formatting and link consistency involves reviewing the target files for structural cleanup and link validation. This review process identifies formatting errors, broken links, and incomplete sections across the Docs directory.

Can I use a style guide to standardize markdown conventions for a Docs directory?

Yes, applying a style guide standardizes markdown conventions for a Docs directory by enforcing repository-specific formatting rules. This aligns all design notes, setup instructions, and release notes with the project's structural and terminology requirements.

When do I need to rewrite technical documentation for a feature change?

Rewriting technical documentation is needed when a feature change alters setup instructions, design notes, or release notes. Updating the markdown pages ensures the documentation reflects the modified implementation details and maintains accurate workflow descriptions.

Does technical writing for markdown require strict alignment with formatting rules?

Technical writing for markdown requires strict alignment with formatting rules to maintain documentation completeness and structural consistency. Adhering to these repository-specific conventions ensures the knowledge assets remain accurate, readable, and properly linked.