skills.rest
dousu
dousuCOMMUNITY
Explore all skills by this author →
𝕏@dousu11GitHub

japanese-doc-validator

Validate Japanese documentation and code comments for punctuation and formatting rules.

3|Updated Nov 4, 2022
Search Tags:#documentation#validation#code style#formatting#japanese#punctuation
One-click install
npx skills add https://github.com/dousu/maou --skill japanese-doc-validator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: japanese-doc-validator
Source: https://github.com/dousu/maou/tree/main/.claude/skills/japanese-doc-validator
Command: npx skills add https://github.com/dousu/maou --skill japanese-doc-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enforces strict Japanese punctuation and formatting rules in documentation and code comments, preventing common errors that can lead to misinterpretation or unprofessionalism.

Core Features & Use Cases

  • Punctuation Validation: Checks for correct usage of full-width commas (，) and periods (．), and half-width parentheses (()).
  • Format Compliance: Ensures adherence to project-specific Japanese text formatting standards.
  • Use Case: Before committing a new Japanese docstring, use this Skill to automatically scan it for any incorrect punctuation (like using 。instead of ．) or misplaced parentheses, ensuring consistency and clarity.

Quick Start

Validate the Japanese documentation formatting in the file '/src/maou/domain/data/schema.py'.

Frequently Asked Questions about japanese-doc-validator

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

FAQPage Schema
How do I validate Japanese punctuation in markdown files and docstrings?▼

To validate Japanese punctuation in markdown files and docstrings, you scan your codebase to check for correct full-width commas, full-width periods, and half-width parentheses. This identifies formatting violations to ensure documentation consistency.

What is the correct punctuation format for Japanese documentation?▼

The correct Japanese documentation format requires full-width commas (，), full-width periods (．), and half-width parentheses (()). Enforcing these specific formatting rules prevents common punctuation errors and misinterpretations in technical text.

Can I use grep and glob to check full-width comma formatting in Python comments?▼

Yes, you can use grep and glob to check full-width comma formatting in Python comments. These pattern matching and file searching tools scan your code comments and docstrings to identify and report incorrect Japanese punctuation usage.

What's the best way to enforce Japanese text formatting standards before committing?▼

The best way to enforce Japanese text formatting standards before committing is to automatically scan docstrings and markdown files for incorrect punctuation. This catches misplaced parentheses or wrong periods, ensuring strict compliance and clarity.

Why does my Japanese docstring validation keep flagging half-width parentheses?▼

Your Japanese docstring validation keeps flagging half-width parentheses because the formatting rules strictly require half-width parentheses (()) instead of full-width alternatives. The validator enforces these standards to maintain professional consistency across your documentation.

Related Skills

Explore More Software Engineering Skills→
Dinhpham04Dinhpham04

translate-japanese-ui

Detect Japanese UI strings in source code and replace them with translation keys.

Community
Intermediate
fartmonarchfartmonarch
1

chinese-documentation

Correct spacing, punctuation, terminology, and markdown in Chinese technical documentation.

Community
Basic
mvillmowmvillmow
18

doc-validate-markdown

Validate Markdown formatting and style compliance with markdownlint.

Community
Intermediate
langgeniuslanggenius
175

dify-docs-format-check-cjk

Check formatting compliance in changed zh and ja Markdown or MDX files.

Official
Intermediate