What kind of language does this skill avoid?

This skill explicitly avoids 'marketing language' such as 'production ready', 'powerful', or 'comprehensive', as well as fluff like development history and roadmaps.

Can I use emojis with the md-style skill?

No, the style guide explicitly instructs to use no emojis unless they are specifically requested by the user.

Why does this skill exclude tables of contents?

The style guide prioritizes brevity for experienced engineers; if a README is concise enough to follow these rules, a table of contents is considered unnecessary fluff.

Does this skill help with markdown formatting?

While it focuses on writing style, it works best alongside the /md-writer skill which handles markdown syntax rules and conventions.

Concise README Style Guide

Name: Concise README Style Guide
Author: jimweller

byjimweller

0•

学习与文档

Enforces a direct, no-fluff writing style for engineering READMEs that prioritizes technical specifications over marketing language.

The md-style skill is designed to transform verbose documentation into concise, high-density engineering specifications. It provides a strict framework for Claude when creating or updating README.md files, ensuring that the output is tailored for experienced engineers. By eliminating roadmaps, marketing hyperbole, and redundant explanations, this skill helps maintain documentation that focuses strictly on the current state of the software, including architecture, usage, and configuration through standardized templates and tables.

主要功能

01Enforces a 'no-fluff' policy by removing marketing hyperbole and roadmaps

02Standardizes documentation structure with specific usage and architecture sections

03Converts verbose descriptions into concise tables and structured lists

04Maintains a direct technical voice focused on facts rather than opinions

05Ensures high-density information by removing tables of contents and redundant facts

060 GitHub stars

使用场景

01Standardizing README files across a professional monorepo or microservices

02Converting marketing-heavy documentation into technical engineering specifications

03Drafting concise setup and configuration guides for new technical tools

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles md-style

For use in Claude.ai and ChatGPT

主要功能

01Enforces a 'no-fluff' policy by removing marketing hyperbole and roadmaps

02Standardizes documentation structure with specific usage and architecture sections

03Converts verbose descriptions into concise tables and structured lists

04Maintains a direct technical voice focused on facts rather than opinions

05Ensures high-density information by removing tables of contents and redundant facts

060 GitHub stars

使用场景

01Standardizing README files across a professional monorepo or microservices

02Converting marketing-heavy documentation into technical engineering specifications

03Drafting concise setup and configuration guides for new technical tools

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles md-style

For use in Claude.ai and ChatGPT