What does the Good Examples skill do?

It reads markdown files and provides a structured summary including the count of sections and bullet points to validate document structure.

Does this skill modify my files?

No, it only uses the Read tool to analyze content and does not perform any write operations or file modifications.

When should I use this skill?

Use it when you need to validate that a document follows structural best practices or to get a quick overview of a markdown file's complexity.

Is this suitable for large code refactors?

No, this skill is specifically designed for small markdown summaries and structural analysis, not for large-scale multi-file code transformations.

What happens if the markdown file is malformed?

The skill includes built-in error handling that identifies parsing failures and provides the specific line number where the error occurred for easy fixing.

Markdown Good Examples Reviewer

Name: Markdown Good Examples Reviewer
Author: smykla-skalski

bysmykla-skalski

•

Seguridad y Pruebas

Analyzes markdown files to validate and summarize structured content against best-practice signals.

The Good Examples skill acts as a specialized review fixture for Claude Code, designed to parse markdown documents and identify key structural elements like headers and bullet points. It provides a concise summary of the document's structure, allowing developers to quickly validate that documentation or test fixtures follow established best-practice patterns. By quantifying sections and points, it offers a high-level overview of content density and organization without the need for manual inspection, making it ideal for maintaining high-quality project documentation.

Características Principales

012 GitHub stars

02Parses markdown headers and bullet points automatically

03Generates concise structural summaries and element counts

04Validates positive best-practice signals in documentation

05Non-destructive read-only analysis of project files

06Identifies empty content or parsing errors with line context

Casos de Uso

01Reviewing documentation files for consistent formatting and structure

02Quantifying content density in markdown notes or requirement documents

03Auditing test fixtures to ensure they contain necessary tagged examples

Características Principales

012 GitHub stars

02Parses markdown headers and bullet points automatically

03Generates concise structural summaries and element counts

04Validates positive best-practice signals in documentation

05Non-destructive read-only analysis of project files

06Identifies empty content or parsing errors with line context

Casos de Uso

01Reviewing documentation files for consistent formatting and structure

02Quantifying content density in markdown notes or requirement documents

03Auditing test fixtures to ensure they contain necessary tagged examples