How does the document splitting rule work?

If a document exceeds roughly 300 lines, the skill automatically splits it into logical sections within a new directory, using numeric prefixes like 01- and 02- to maintain order.

Can I use this for existing documentation?

Yes, the skill can read and edit existing Markdown files to refactor them into the standardized format, including converting diagrams or splitting oversized files.

Does it support custom naming conventions?

The skill follows a strict kebab-case naming convention with sequential prefixes to ensure maximum compatibility and readability across all operating systems.

Why does this skill prohibit ASCII art?

ASCII art is difficult to maintain and often breaks on different screen sizes. This skill enforces Mermaid or PlantUML to ensure diagrams are scalable, searchable, and professional.

Which diagram formats are supported?

The skill primarily uses Mermaid and PlantUML. Simple tree structures are the only exception where standard text formatting is permitted.

Markdown Writing

Name: Markdown Writing
Author: takemi-ohama

bytakemi-ohama

0•

内容管理

Standardizes the creation of professional technical documentation through automated diagram generation and smart file splitting.

The Markdown Writing skill enforces high-quality documentation standards within Claude Code by automating best practices for technical writing. It ensures all diagrams are created using Mermaid or PlantUML rather than brittle ASCII art, and maintains repository maintainability by enforcing a 300-line limit per file. When documentation grows too large, the skill automatically organizes content into structured directories using sequential prefixes (01-, 02-) and kebab-case naming, making it an essential tool for developers and technical writers building scalable project guides.

主要功能

01Sequential file prefixing (01-, 02-) for organized multi-part docs

02Smart document splitting for any file exceeding 300 lines

03Automated diagram generation using Mermaid and PlantUML syntax

04Directory-based structure management for complex technical guides

05Strict prohibition of ASCII art to maintain professional standards

060 GitHub stars

使用场景

01Standardizing documentation formatting across a collaborative development team

02Managing large-scale technical manuals by splitting them into modular sections

03Generating architecture diagrams and flowcharts for system design

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add takemi-ohama/ai-plugins markdown-writing

For use in Claude.ai and ChatGPT

Download Skill