Can I use this for local documentation files?

Yes. If the GitHub MCP tool is not detected, the skill automatically switches to 'Local review mode' and outputs a numbered list of issues directly in the conversation.

Why are the issues numbered sequentially?

Mandatory sequential numbering allows developers to efficiently reference specific items (e.g., 'fix issues 1 and 4') and ensures no feedback is missed during the revision process.

How does this skill handle GitHub Pull Requests?

It uses a pending review workflow to batch all identified issues into a single, cohesive GitHub review, avoiding notification spam and keeping comments organized.

Does it support specific writing style guides?

It is pre-configured with the Metabase writing style guide but can be adapted to any technical documentation standards focusing on tone, clarity, and Markdown formatting.

Documentation Style Reviewer

Name: Documentation Style Reviewer
Author: Microck

byMicrock

•

内容管理

Audits documentation files and pull requests against style guides to ensure clarity, consistency, and professional tone.

The Documentation Review skill automates the editorial process for technical documentation, specifically optimized for Markdown files. It scans changes for stylistic issues—such as overly formal language, incorrect UI element formatting, and vague headings—providing structured, numbered feedback that is easy to action. Whether working locally or via GitHub Pull Requests, it helps maintain high standards of readability by identifying material issues while filtering out trivialities, ensuring your documentation remains accessible and user-centric.

主要功能

0181 GitHub stars

02Sequentially numbered feedback for efficient issue tracking

03Automated style guide compliance checks for Markdown files

04Validation of code examples, links, and UI element formatting

05Integrated GitHub PR review workflow with pending review support

06Heuristic analysis of tone, voice, and structural clarity

使用场景

01Automating documentation reviews during the GitHub Pull Request process

02Self-checking local documentation drafts for style guide compliance

03Ensuring technical writing consistency across multi-author documentation repositories

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add microck/ordinary-claude-skills docs-review

For use in Claude.ai and ChatGPT

Download Skill