writing-style-markdown

Enforce Markdown conventions with bullet lists, Mermaid diagrams, and semantic line breaks.

Updated Mar 25, 2020
One-click install
npx skills add https://github.com/daominah/gostructure --skill writing-style-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-style-markdown
Source: https://github.com/daominah/gostructure/tree/main/.claude/skills/writing-style-markdown
Command: npx skills add https://github.com/daominah/gostructure --skill writing-style-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes consistent, readable Markdown conventions so documentation and notes remain easy to edit, review, and render across tools and teams.

Core Features & Use Cases

  • Bullet-first lists: Prefer bullet points for flexibility and easier editing; use numbered lists only when explicit ordering or referencing is required.
  • Mermaid diagrams by default: Use Mermaid syntax for sequence and other diagrams to keep diagrams source-controlled and editable.
  • Semantic line breaks: Break lines at semantic boundaries around 80 characters (allowing up to 100) with exceptions for tables and skill frontmatter, improving raw-source readability.
  • Use Case: Ideal for README files, technical guides, and collaborative documentation where clean diffs and editor readability matter.

Quick Start

Apply the writing-style-markdown rules to the project's README to convert numbered lists to bullets where possible, add Mermaid diagrams for visual flows, and rewrap paragraphs to semantic line breaks around 80 characters.

Frequently Asked Questions about writing-style-markdown

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

FAQPage Schema
How do I enforce consistent markdown writing conventions across documentation files?

To enforce consistent markdown writing conventions, apply rules that standardize bullet lists, Mermaid diagrams, and semantic line breaks around 80 characters to improve readability and maintainability across files.

What is the best way to format markdown diagrams for version control?

The best way to format markdown diagrams for version control is using Mermaid syntax, which keeps sequence and flow diagrams source-controlled, text-based, and easily editable directly within documentation files.

Why use semantic line breaks in markdown documentation?

Use semantic line breaks in markdown documentation to break lines at natural sentence boundaries around 80 to 100 characters, which significantly improves raw-source readability and produces cleaner diffs during collaborative editing.

When should I use bullet lists instead of numbered lists in markdown?

Use bullet lists in markdown by default for flexibility and easier editing, and reserve numbered lists only for situations requiring explicit sequential ordering or direct step referencing.

Can I apply markdown formatting rules to existing README files?

Yes, you can apply markdown formatting rules to existing README files by converting numbered lists to bullets, adding Mermaid diagrams for visual flows, and rewrapping paragraphs to semantic line breaks.

Are there exceptions to the semantic line wrapping rules for markdown tables?

Yes, exceptions to semantic line wrapping rules include markdown tables and skill frontmatter, which are skipped to preserve their structural integrity and rendering compatibility across tools.