Does it support diagrams and visual content?

Yes, it specifically promotes the use of Mermaid for creating diagrams directly within Markdown, reducing the need for external image files.

Will this skill automatically change my files?

No, it identifies errors first. It only applies automatic fixes if you explicitly provide the --fix instruction, ensuring you have total control over your content.

Why does it discourage putting code in specification documents?

Separating implementation code from specifications ensures that documentation remains easy to maintain and doesn't become outdated as the codebase evolves.

How does this skill improve my Markdown documentation?

It applies a rigorous set of stylistic rules and uses markdownlint-cli2 to identify and resolve common issues with headers, lists, and file formatting.

Can I use this for Japanese language projects?

Absolutely. This skill includes specific guidelines for Japanese technical writing, including the use of 'Joutai' (plain form) and specific emoji placement rules.

Documentation Standards

Name: Documentation Standards
Author: RevTechStudio

byRevTechStudio

콘텐츠 관리

Enforces consistent Markdown styling, linguistic rules, and linting validation for high-quality technical documentation.

소개

The Documentation Standards skill provides a comprehensive framework for creating professional Markdown documents by defining clear stylistic rules, such as the use of Japanese plain form, specific emoji usage policies, and Mermaid for diagrams. It automates the quality assurance process by integrating markdownlint-cli2 validation, ensuring that all READMEs, specifications, and project guides remain consistent, accessible, and free from common formatting errors while keeping implementation code separate from high-level requirements.

주요 기능

Integrated markdownlint-cli2 validation with predefined rule sets
Standardized Japanese writing style and consistent indentation rules
Automated checking for header hierarchy, list formatting, and spacing errors
Mermaid diagram integration for visual documentation without external assets
Strict separation of technical specifications from implementation code
0 GitHub stars

사용 사례

Creating technical requirement documents that focus on logic rather than code
Automating documentation quality checks within a development workflow
Standardizing README files and project manuals across multiple repositories

소개

주요 기능

Integrated markdownlint-cli2 validation with predefined rule sets
Standardized Japanese writing style and consistent indentation rules
Automated checking for header hierarchy, list formatting, and spacing errors
Mermaid diagram integration for visual documentation without external assets
Strict separation of technical specifications from implementation code
0 GitHub stars

사용 사례

Creating technical requirement documents that focus on logic rather than code
Automating documentation quality checks within a development workflow
Standardizing README files and project manuals across multiple repositories